diff --git a/content/_generate-recovery-token.md b/content/docs/admonitions/_generate-recovery-token.md similarity index 92% rename from content/_generate-recovery-token.md rename to content/docs/admonitions/_generate-recovery-token.md index 1e885fbf7..c8340fc98 100644 --- a/content/_generate-recovery-token.md +++ b/content/docs/admonitions/_generate-recovery-token.md @@ -1,6 +1,6 @@ In the event that you lose access to the console via delegated access (the policy defined in Pomerium), there exists a fallback procedure to regain access to the console via a generated recovery token. -![Pomerium Enterprise Recovery Sign In](docs/manage/img/recovery-token.png) +![Pomerium Enterprise Recovery Sign In](./img/recovery-token.png) To generate a token, run the `pomerium-console generate-recovery token` command with the following flags: diff --git a/content/_install-mkcert.md b/content/docs/admonitions/_install-mkcert.md similarity index 100% rename from content/_install-mkcert.md rename to content/docs/admonitions/_install-mkcert.md diff --git a/content/docs/manage/img/recovery-token.png b/content/docs/admonitions/img/recovery-token.png similarity index 100% rename from content/docs/manage/img/recovery-token.png rename to content/docs/admonitions/img/recovery-token.png diff --git a/content/docs/deploy/clients/clients.mdx b/content/docs/deploy/clients/clients.mdx index f5e39df0e..cde65ae36 100644 --- a/content/docs/deploy/clients/clients.mdx +++ b/content/docs/deploy/clients/clients.mdx @@ -25,6 +25,7 @@ keywords: ] lang: en-US --- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import LongLivedConnections from '@site/content/docs/admonitions/_long-lived-connections.mdx'; @@ -316,7 +317,6 @@ pomerium-cli udp dns.example.com:53 dig @127.0.0.1 -p 52544 google.com ``` - ```shell pomerium-cli tcp [destination] [flags] ``` @@ -418,10 +418,6 @@ Then, connect to a TCP route: ssh -o ProxyCommand='pomerium-cli tcp --listen - %h:%p' ssh.localhost.pomerium.io ``` - - - - ## Best Practices - **mTLS** diff --git a/content/docs/deploy/k8s/quickstart.mdx b/content/docs/deploy/k8s/quickstart.mdx index 7ab74fa38..f39134140 100644 --- a/content/docs/deploy/k8s/quickstart.mdx +++ b/content/docs/deploy/k8s/quickstart.mdx @@ -20,7 +20,7 @@ keywords: import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import InstallMkcert from '@site/content/_install-mkcert.md'; +import InstallMkcert from '@site/content/docs/admonitions/_install-mkcert.md'; import GlobalExample from '@site/content/examples/kubernetes/pomerium-global-settings.md'; Deploy Pomerium Core with [Kubernetes]. diff --git a/content/docs/guides/gitlab.mdx b/content/docs/guides/gitlab.mdx index ddbe319c8..25d729394 100644 --- a/content/docs/guides/gitlab.mdx +++ b/content/docs/guides/gitlab.mdx @@ -19,7 +19,7 @@ description: This guide covers how to secure self-hosted GitLab behind Pomerium, import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import InstallMkcert from '@site/content/_install-mkcert.md'; +import InstallMkcert from '@site/content/docs/admonitions/_install-mkcert.md'; [GitLab] is a highly customizable, highly configurable tool to manage source code, project management, and many other aspects of project development. In addition to the SaaS product, its self-hosted solution and easy free-to-enterprise upgrade path make it a popular choice for those managing sensitive code bases. diff --git a/content/docs/guides/helm.mdx b/content/docs/guides/helm.mdx index db240e58e..fd4f4a263 100644 --- a/content/docs/guides/helm.mdx +++ b/content/docs/guides/helm.mdx @@ -16,7 +16,7 @@ keywords: ] --- -import InstallMkcert from '@site/content/_install-mkcert.md'; +import InstallMkcert from '@site/content/docs/admonitions/_install-mkcert.md'; import PomeriumCerts from '@site/content/examples/kubernetes/pomerium-certificates.yaml.md'; import PomeriumValues from '@site/content/examples/kubernetes/pomerium-values.yaml.md'; import ExampleIngress from '@site/content/examples/kubernetes/example-ingress.yaml.md'; diff --git a/content/docs/integrations.mdx b/content/docs/integrations.mdx index 67fd3c8de..00b3641d0 100644 --- a/content/docs/integrations.mdx +++ b/content/docs/integrations.mdx @@ -30,7 +30,7 @@ See the pages in this section for more information on our example data sources, ## Integrate external data sources in the Console -![Configure external data sources in the Console](./img/external-data-gui.gif) +![Configure external data sources in the Console](./integrations/img/external-data-gui.gif) Any external data source integration requires the following settings: diff --git a/content/docs/img/external-data-gui.gif b/content/docs/integrations/img/external-data-gui.gif similarity index 100% rename from content/docs/img/external-data-gui.gif rename to content/docs/integrations/img/external-data-gui.gif diff --git a/content/docs/internals/configuration.md b/content/docs/internals/configuration.mdx similarity index 96% rename from content/docs/internals/configuration.md rename to content/docs/internals/configuration.mdx index 5690791b6..0ecfc3bf6 100644 --- a/content/docs/internals/configuration.md +++ b/content/docs/internals/configuration.mdx @@ -1,6 +1,17 @@ --- -title: Configuration & Settings -sidebar_label: Configuration +title: 'Configuration & Settings' +description: 'Optimize your Pomerium deployment with flexible configuration for all-in-one or split-service modes, including environment variables, route reloading, scaling, and more.' +sidebar_label: 'Configuration' +keywords: + - pomerium + - configuration + - settings + - environment variables + - split service mode + - docker compose + - all-in-one mode + - advanced pomerium config +lang: en-US --- # Configuration & Settings @@ -29,7 +40,7 @@ Alternately, you can create individual config files or sets of environment varia The table contains all config options for Pomerium Core. You can also browse each key using the index on the left. -import InstallMkcert from '@site/content/\_install-mkcert.md'; +import InstallMkcert from '@site/content/docs/admonitions/_install-mkcert'; ## Service Mode diff --git a/content/docs/internals/troubleshooting.mdx b/content/docs/internals/troubleshooting.mdx index 1795c2ef4..4336e8ecc 100644 --- a/content/docs/internals/troubleshooting.mdx +++ b/content/docs/internals/troubleshooting.mdx @@ -18,7 +18,7 @@ keywords: import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import GenerateRecoveryToken from '@site/content/_generate-recovery-token.md'; +import GenerateRecoveryToken from '@site/content/docs/admonitions/_generate-recovery-token.md'; ## Pomerium Zero diff --git a/content/docs/manage/img/logged-in-as.png b/content/docs/manage/img/logged-in-as.png deleted file mode 100644 index 3eef6af88..000000000 Binary files a/content/docs/manage/img/logged-in-as.png and /dev/null differ diff --git a/sidebars.js b/sidebars.js index 7e7e89318..ef9940423 100644 --- a/sidebars.js +++ b/sidebars.js @@ -27,11 +27,10 @@ const sidebars = { { type: 'category', label: 'Deploy', - // link: {type: 'doc', id: 'docs/deploy/index'}, // optional parent doc items: [ { type: 'autogenerated', - dirName: 'docs/deploy', // directory to autogenerate from + dirName: 'docs/deploy', }, ], },