Skip to content

Commit

Permalink
Refactor documentation and update resource paths
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
desimone committed Dec 31, 2024
1 parent 200b6b0 commit e160a6f
Show file tree
Hide file tree
Showing 13 changed files with 22 additions and 16 deletions.
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
File renamed without changes.
File renamed without changes
6 changes: 1 addition & 5 deletions content/docs/deploy/clients/clients.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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]
```
Expand Down Expand Up @@ -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**
Expand Down
2 changes: 1 addition & 1 deletion content/docs/deploy/k8s/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down
2 changes: 1 addition & 1 deletion content/docs/guides/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/guides/helm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
2 changes: 1 addition & 1 deletion content/docs/integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
File renamed without changes
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion content/docs/internals/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Binary file removed content/docs/manage/img/logged-in-as.png
Binary file not shown.
3 changes: 1 addition & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
},
],
},
Expand Down

0 comments on commit e160a6f

Please sign in to comment.