docs: update docs for v0.0.5

This commit is contained in:
Bobby DeSimone 2019-06-04 15:21:25 -07:00
parent 4ce4e1e124
commit e9faefea16
No known key found for this signature in database
GPG key ID: AEE4CF12FE86D07E
8 changed files with 35 additions and 28 deletions

View file

@ -12,6 +12,16 @@ Remember to set your identity provider settings and to generate new secret keys!
:::
## Configurations
#### Configuration File
<<< @/docs/docs/examples/config/config.example.yaml
#### Environmental Variables
<<< @/docs/docs/examples/config/config.example.env
## Binary
- Suitable for bare-metal and virtual-machines
@ -24,14 +34,6 @@ Remember to set your identity provider settings and to generate new secret keys!
Customize for your identity provider and run `./bin/pomerium -config config.yaml`
#### Config file example
<<< @/docs/docs/examples/config/config.example.yaml
#### Environmental variable example
<<< @/docs/docs/examples/config/config.example.env
## Docker

View file

@ -44,7 +44,7 @@ Pomerium attempts to mitigate these shortcomings by adopting principles like:
- Every device, user, and application's communication should be authenticated, authorized, and encrypted.
- Access policy should be dynamic, and built from multiple sources.
This security model has typically been referred to as zero-trust or BeyondCorp-inspired.
This security model has typically been referred to as *zero-trust* or *BeyondCorp*-inspired.
## Resources

View file

@ -25,19 +25,19 @@ Pomerium supports setting [configuration variables] using both environmental var
### Configuration file
Create a config file (`config.yaml`). This configuration file will be use to determine Pomerium's configuration settings, routes, and access-policies. Consider the following example:
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/docs/examples/config/config.minimal.yaml
### Environmental Variables
As mentioned above, Pomerium supports mixing and matching where configuration details are set. For example, we can specify our secret values and domains certificates as [environmental configuration 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/docs/examples/config/config.minimal.env
## Run
Finally, source the the configuration `env` file and run pomerium specifying the `config.yaml` you just created.
Finally, source the the configuration `env` file and run pomerium specifying the `config.yaml` .
```bash
source ./env

View file

@ -8,12 +8,12 @@ meta:
# Building Pomerium From Source
The following quick-start guide covers how to retrieve and build Pomerium directly from it's source as well as how to run Pomerium using a minimal but complete configuration.
The following quick-start guide covers how to retrieve and build Pomerium directly from it's source-code as well as how to run Pomerium using a minimal but complete configuration. One of the benefits of compiling from source is that Go supports building static binaries for a [wide array of architectures and operating systems](https://gist.github.com/asukakenji/f15ba7e588ac42795f421b48b8aede63) — some of which may not yet be supported by Pomerium's official images or binaries.
## Prerequisites
- Install [git](https://git-scm.com/) version control system
- Install the [go](https://golang.org/doc/install) programming language
- [git](https://git-scm.com/)
- [go](https://golang.org/doc/install) programming language
- A configured [identity provider]
- A [wild-card TLS certificate]
@ -34,7 +34,7 @@ cd $HOME/pomerium
make
```
[Make] will run all the tests, some code linters, then build the binary. If all is good, you should now have a freshly built pomerium binary in the `pomerium/bin` directory.
[Make] will run all the tests, some code linters, then build the binary. If all is good, you should now have a freshly built pomerium binary for your architecture and operating system in the `pomerium/bin` directory.
## Configure
@ -42,7 +42,7 @@ Pomerium supports setting [configuration variables] using both environmental var
### Configuration file
Create a config file (`config.yaml`). This configuration file will be use to determine Pomerium's configuration settings, routes, and access-policies. Consider the following example:
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/docs/examples/config/config.minimal.yaml
@ -54,7 +54,7 @@ As mentioned above, Pomerium supports mixing and matching where configuration de
## Run
Finally, source the the configuration `env` file and run pomerium specifying the `config.yaml` you just created.
Finally, source the the configuration `env` file and run pomerium specifying the configuration file `config.yaml`.
```bash
source ./env

View file

@ -10,7 +10,7 @@ meta:
This quickstart will show you how to deploy Pomerium with Kubernetes. Though there are [many ways](https://kubernetes.io/docs/setup/pick-right-solution/) to work with Kubernetes, for the purpose of this guide, we will be using Google's [Kubernetes Engine](https://cloud.google.com/kubernetes-engine/). That said, most of the following steps should be very similar using any other provider.
In addition to sharing many of the same features as the Kubernetes quickstart guide, the default helm deployment script also includes a bootstrapped certificate authority enabling mutually authenticated and encrypted communication between services that does not depend on the external LetsEncrypt certificates. Having the external domain certificate decoupled makes it easier to renew external certificates.
In addition to sharing many of the same features as the Kubernetes quickstart guide, the default helm deployment script also includes a bootstrapped certificate authority enabling mutually authenticated and encrypted communication between services that does not depend on the external LetsEncrypt certificates. Having the external domain certificate de-coupled makes it easier to renew external certificates.
## Prerequisites

View file

@ -3,12 +3,12 @@ title: Docker
lang: en-US
meta:
- name: keywords
content: pomerium identity-access-proxy oidc docker reverse-proxy
content: pomerium identity-access-proxy oidc docker reverse-proxy containers
---
# Pomerium using Docker
[Docker] is a simple and easy way to start using Pomerium. In the following quick-start, we'll create a minimal but complete environment for running Pomerium with containers.
[Docker] is a straightforward way to start using Pomerium. In the following quick-start, we'll create a minimal but complete environment for running Pomerium with containers.
## Prerequisites
@ -22,7 +22,7 @@ meta:
Download the following `docker-compose.yml` file and modify it to:
- use newly generated secrets
- generate new secrets
- mount your [wild-card TLS certificate]
- mount Pomerium's `config.yaml` [configuration file]

View file

@ -1,8 +1,13 @@
---
home: true
heroImage: logo.svg
heroText: " "
tagline: Pomerium is a context and identity aware access proxy.
actionText: Read the docs
actionLink: /docs/
heroText: "latest"
tagline: "Pomerium is a context and identity aware access proxy."
---
### Earlier Versions
- [v0.0.5](https://v0-0-5.docs.pomerium.io)
- [v0.0.4](https://v0-0-4.docs.pomerium.io)

View file

@ -4,7 +4,7 @@ sidebar: auto
# Configuration
Pomerium can be configured using a either a configuration file ([YAML]/[JSON]/[TOML]) or [environmental variables]. In general, environmental variable keys are identical to config file keys but are in all uppercase.
Pomerium can be configured using a configuration file ([YAML]/[JSON]/[TOML]) or [environmental variables]. In general, environmental variable keys are identical to config file keys but are in uppercase.
If you are coming from a kubernetes or docker background this should feel familiar. If not, check out the following primers.
@ -364,7 +364,7 @@ If your load balancer does not support gRPC pass-through you'll need to set this
- Optional (but typically required if Authenticate Internal Service Address is set)
- Example: `*.corp.example.com` if wild card or `authenticate.corp.example.com`/`authorize.corp.example.com`
When Authenticate Internal Service Address is set, secure service communication can fail because the external certificate name will not match the internally routed service url. This setting allows you to override that check.
When Authenticate Internal Service Address is set, secure service communication can fail because the external certificate name will not match the internally routed service hostname/[SNI](<https://en.wikipedia.org/wiki/Server_Name_Indication>). This setting allows you to override that check.
### Certificate Authority