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

Update binary install doc (#2447)

Browse source 
* fix route block in example config

* Update binary install to include OS packages

* update references to policy docs
This commit is contained in:
Alex Fornuto 2021-08-06 12:43:57 -05:00 • committed by GitHub
parent 5cfad79447
commit 33f7e8487a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 30 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/docs/install/binary.md
View file

@ -17,6 +17,14 @@ This document covers how to configure and run Pomerium using the official prebui
## Download
You can download the latest release from GitHub, or use the repositories we provide through [Cloudsmith]. In addition to the easy updates provided by the package manager, the `deb` and `rpm` packages include systemd service unit configurations.
### Operating System Packages
Through [Cloudsmith][cloudsmith-repo], we provide OS packages for Linux distributions using `deb` and `rpm` style package managers. Select your system's package format and architecture, then use the **Setup** tab to add the repository to your package manager.
### Standalone Binary
[Download] the latest release of Pomerium for your machine's operating system and architecture.
## Configure
@ -25,13 +33,27 @@ Pomerium supports setting [configuration variables] using both environmental var
### Configuration file
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:
When using our OS packages, we provide a default configuration at `/etc/pomerium/config.yaml`. Otherwise, create the config file (`config.yaml`) in your preferred location.
This file will be used to determine Pomerium's configuration settings, routes, and access-policies. Consider the following example:
<<< @/examples/config/config.minimal.yaml
You can also set some or all of your configuration keys as environment variables, in an `env` file for example. See the [Reference] page to identify the environment variable for each configuration option.
## Run
Finally, source the configuration `env` file and run pomerium specifying the `config.yaml` .
### OS Package
Enable and start the service:
```bash
sudo systemctl enable --now pomerium.service
```
### Manual Installation
Source the configuration `env` file, if present, and run pomerium specifying the `config.yaml` .
```bash
./bin/pomerium -config config.yaml
@ -46,3 +68,6 @@ Browse to `external-verify.your.domain.example`. Connections between you and [ve
[verify]: https://verify.pomerium.com/
[identity provider]: /docs/identity-providers/readme.md
[tls certificates]: /docs/topics/certificates.md
[Cloudsmith]: https://cloudsmith.io
[cloudsmith-repo]: https://cloudsmith.io/~pomerium/repos/pomerium/groups/
[Reference]: /reference/readme.md

2
docs/guides/local-oidc.md
View file

@ -77,7 +77,7 @@ idp_client_secret: bar
# Generate 256 bit random keys e.g. `head -c32 /dev/urandom | base64`
cookie_secret: <reducted>
# https://www.pomerium.io/configuration/#policy
# https://pomerium.io/reference/#routes
routes:
- from: https://verify.localhost.pomerium.io
to: http://verify

4
examples/config/config.minimal.yaml
View file

@ -18,8 +18,8 @@ idp_client_secret: REPLACE_ME
# Generate 256 bit random keys e.g. `head -c32 /dev/urandom | base64`
cookie_secret: WwMtDXWaRDMBQCylle8OJ+w4kLIDIGd8W3cB4/zFFtg=
# https://www.pomerium.io/configuration/#policy
policy:
# https://pomerium.io/reference/#routes
routes:
- from: https://verify.localhost.pomerium.io
to: https://verify.pomerium.com
policy: