3pp-mirror/pomerium
1
0
Fork 0
mirror of https://github.com/pomerium/pomerium.git synced 2025-06-06 04:42:56 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: refactor sections, consolidate examples (#1164)

Browse source
This commit is contained in:
bobby 2020-07-30 11:02:14 -07:00 • committed by GitHub
parent f41eeaf138
commit 8cae3f27bb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
74 changed files with 85 additions and 194 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/docs/quick-start/binary.md
View file

@ -27,13 +27,13 @@ Pomerium supports setting [configuration variables] using both environmental var
Create a config file (`config.yaml`). This file will be used to determine Pomerium's configuration settings, routes, and access-policies. Consider the following example:
<<< @/docs/configuration/examples/config/config.minimal.yaml
<<< @/examples/config/config.minimal.yaml
### Environmental Variables
As mentioned above, Pomerium supports mixing and matching configuration. For example, we can specify our secret values and domains certificates as [environmental configuration variables], and set the rest as part of the configuration file.
<<< @/docs/configuration/examples/config/config.minimal.env
<<< @/examples/config/config.minimal.env
## Run

2
docs/docs/quick-start/from-source.md
View file

@ -57,7 +57,7 @@ Pomerium supports setting [configuration variables] using both environmental var
Create a config file (`config.yaml`). This file will be use to determine Pomerium's configuration settings, routes, and access-policies. Consider the following example:
<<< @/docs/configuration/examples/config/config.minimal.yaml
<<< @/examples/config/config.minimal.yaml
## Run

4
docs/docs/quick-start/helm.md
View file

@ -27,9 +27,9 @@ In addition to sharing many of the same features as the Kubernetes quickstart gu
Download and modify the following helm_gke.sh script and values file to match your [identity provider] and [TLS certificates] settings.
<<<@/docs/configuration/examples/helm/helm_gke.sh
<<<@/examples/helm/helm_gke.sh
<<<@/docs/configuration/examples/kubernetes/values.yaml
<<<@/examples/kubernetes/values.yaml
## Run

2
docs/docs/quick-start/kubernetes.md
View file

@ -31,7 +31,7 @@ cd $HOME/pomerium/docs/configuration/examples/kubernetes
Edit [./kubernetes_gke.sh] making sure to change the identity provider secret value to match your [identity provider] and [TLS certificates] settings.
<<<@/docs/configuration/examples/kubernetes/kubernetes_gke.sh
<<<@/examples/kubernetes/kubernetes_gke.sh
## Run

6
docs/docs/quick-start/readme.md
View file

@ -22,7 +22,7 @@ In the following quick-start, we'll create a minimal but complete environment fo
Create a [configuration file] (e.g `config.yaml`) for defining Pomerium's configuration settings, routes, and access-policies. Consider the following example:
<<< @/docs/configuration/examples/config/config.minimal.yaml
<<< @/examples/config/config.minimal.yaml
Ensure the `docker-compose.yml` contains the correct path to your `config.yaml`.
@ -36,7 +36,7 @@ Download the following `docker-compose.yml` file and modify it to:
- mount your `config.yaml` [configuration file]
- Set `autocert_use_staging` to `false` once you have finished testing
<<< @/docs/configuration/examples/docker/autocert.docker-compose.yml
<<< @/examples/docker/autocert.docker-compose.yml
Please note that you should use a persistent volume to store certificate data, or you may exhaust your domain quota on Let's Encrypt.
@ -48,7 +48,7 @@ Download the following `docker-compose.yml` file and modify it to:
- mount your [TLS certificates]
- mount your `config.yaml` [configuration file]
<<< @/docs/configuration/examples/docker/basic.docker-compose.yml
<<< @/examples/docker/basic.docker-compose.yml
## Run