Skip to content

Commit e160a6f

Browse files
committed
Refactor documentation and update resource paths
- Updated multiple documentation files to correct paths and improve navigation, including the integration of new recovery token and mkcert installation guides. - Replaced outdated references to the old Pomerium CLI and Desktop client links with updated paths for better clarity. - Added new markdown files for generating recovery tokens and installing mkcert, enhancing user guidance. - Removed obsolete images and files to streamline the documentation structure. These changes improve the organization and accessibility of the documentation, providing users with clearer guidance on Pomerium's features and setup processes.
1 parent 200b6b0 commit e160a6f

13 files changed

+22
-16
lines changed

content/_generate-recovery-token.md content/docs/admonitions/_generate-recovery-token.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
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.
22

3-
![Pomerium Enterprise Recovery Sign In](docs/manage/img/recovery-token.png)
3+
![Pomerium Enterprise Recovery Sign In](./img/recovery-token.png)
44

55
To generate a token, run the `pomerium-console generate-recovery token` command with the following flags:
66

File renamed without changes.

content/docs/deploy/clients/clients.mdx

+1-5
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ keywords:
2525
]
2626
lang: en-US
2727
---
28+
2829
import Tabs from '@theme/Tabs';
2930
import TabItem from '@theme/TabItem';
3031
import LongLivedConnections from '@site/content/docs/admonitions/_long-lived-connections.mdx';
@@ -316,7 +317,6 @@ pomerium-cli udp dns.example.com:53
316317
dig @127.0.0.1 -p 52544 google.com
317318
```
318319

319-
320320
```shell
321321
pomerium-cli tcp [destination] [flags]
322322
```
@@ -418,10 +418,6 @@ Then, connect to a TCP route:
418418
ssh -o ProxyCommand='pomerium-cli tcp --listen - %h:%p' ssh.localhost.pomerium.io
419419
```
420420

421-
422-
423-
424-
425421
## Best Practices
426422

427423
- **mTLS**

content/docs/deploy/k8s/quickstart.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ keywords:
2020

2121
import Tabs from '@theme/Tabs';
2222
import TabItem from '@theme/TabItem';
23-
import InstallMkcert from '@site/content/_install-mkcert.md';
23+
import InstallMkcert from '@site/content/docs/admonitions/_install-mkcert.md';
2424
import GlobalExample from '@site/content/examples/kubernetes/pomerium-global-settings.md';
2525

2626
Deploy Pomerium Core with [Kubernetes].

content/docs/guides/gitlab.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ description: This guide covers how to secure self-hosted GitLab behind Pomerium,
1919

2020
import Tabs from '@theme/Tabs';
2121
import TabItem from '@theme/TabItem';
22-
import InstallMkcert from '@site/content/_install-mkcert.md';
22+
import InstallMkcert from '@site/content/docs/admonitions/_install-mkcert.md';
2323

2424
[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.
2525

content/docs/guides/helm.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ keywords:
1616
]
1717
---
1818

19-
import InstallMkcert from '@site/content/_install-mkcert.md';
19+
import InstallMkcert from '@site/content/docs/admonitions/_install-mkcert.md';
2020
import PomeriumCerts from '@site/content/examples/kubernetes/pomerium-certificates.yaml.md';
2121
import PomeriumValues from '@site/content/examples/kubernetes/pomerium-values.yaml.md';
2222
import ExampleIngress from '@site/content/examples/kubernetes/example-ingress.yaml.md';

content/docs/integrations.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ See the pages in this section for more information on our example data sources,
3030

3131
## Integrate external data sources in the Console
3232

33-
![Configure external data sources in the Console](./img/external-data-gui.gif)
33+
![Configure external data sources in the Console](./integrations/img/external-data-gui.gif)
3434

3535
Any external data source integration requires the following settings:
3636

content/docs/internals/configuration.md content/docs/internals/configuration.mdx

+14-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
---
2-
title: Configuration & Settings
3-
sidebar_label: Configuration
2+
title: 'Configuration & Settings'
3+
description: 'Optimize your Pomerium deployment with flexible configuration for all-in-one or split-service modes, including environment variables, route reloading, scaling, and more.'
4+
sidebar_label: 'Configuration'
5+
keywords:
6+
- pomerium
7+
- configuration
8+
- settings
9+
- environment variables
10+
- split service mode
11+
- docker compose
12+
- all-in-one mode
13+
- advanced pomerium config
14+
lang: en-US
415
---
516

617
# Configuration & Settings
@@ -29,7 +40,7 @@ Alternately, you can create individual config files or sets of environment varia
2940

3041
The table contains all config options for Pomerium Core. You can also browse each key using the index on the left.
3142

32-
import InstallMkcert from '@site/content/\_install-mkcert.md';
43+
import InstallMkcert from '@site/content/docs/admonitions/_install-mkcert';
3344

3445
## Service Mode
3546

content/docs/internals/troubleshooting.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ keywords:
1818

1919
import Tabs from '@theme/Tabs';
2020
import TabItem from '@theme/TabItem';
21-
import GenerateRecoveryToken from '@site/content/_generate-recovery-token.md';
21+
import GenerateRecoveryToken from '@site/content/docs/admonitions/_generate-recovery-token.md';
2222

2323
## Pomerium Zero
2424

-276 KB
Binary file not shown.

sidebars.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,10 @@ const sidebars = {
2727
{
2828
type: 'category',
2929
label: 'Deploy',
30-
// link: {type: 'doc', id: 'docs/deploy/index'}, // optional parent doc
3130
items: [
3231
{
3332
type: 'autogenerated',
34-
dirName: 'docs/deploy', // directory to autogenerate from
33+
dirName: 'docs/deploy',
3534
},
3635
],
3736
},

0 commit comments

Comments
 (0)