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

docs : update readme and quickstart

Browse source
This commit is contained in:
Bobby DeSimone 2019-01-17 09:20:16 -08:00
parent ae4fd837a0
commit b312357c01
No known key found for this signature in database
GPG key ID: AEE4CF12FE86D07E
2 changed files with 13 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -15,7 +15,7 @@ Use Pomerium to:
- deploy mutual authenticated encryption (mTLS). - deploy mutual authenticated encryption (mTLS).
- aggregate logging and telemetry data. - aggregate logging and telemetry data.
To learn more about the problems Pomerium attempts to address, check out this repository of [resources] covering zero-trust and BeyondCorp. To learn more about some problems Pomerium attempts to address, check out this repository of [resources] covering zero-trust and BeyondCorp.
## Get started ## Get started

18
docs/guide/readme.md
View file

@ -3,22 +3,26 @@
## Using Docker ## Using Docker
* Install [docker](https://docs.docker.com/install/). * Install [docker] and [docker-compose].
* Install [docker-compose](https://docs.docker.com/compose/install/). * Grab Pomerium's included example [`docker-compose.yml`](https://raw.githubusercontent.com/pomerium/pomerium/master/docker-compose.yml) directly or by cloning the repository.
* Save Pomerium's example [`docker-compose.yml`](). * Update `docker-compose.yml` to match your [identity provider] settings.
* Inspect the `docker-compose.yml` file. In addition to specifying Pomerium's configuration settings, and services, you'll see that there are other included services to give you a feel for how pomerium works. * Copy your subdomain's wild-card TLS certificate next to the compose file. If you don't have one handy, the included [script] generates one from [LetsEncrypt].
* Update the compose file with your [identity provider] settings.
* Copy your subdomain's wild-card TLS certificate next to the compose file. See included [script] to generate one from LetsEncrypt.
* Run docker compose by runnig the command `$ docker-compose up`. * Run docker compose by runnig the command `$ docker-compose up`.
* If you navigate to `https://hello.corp.beyondperimeter.com` or `https://httpbin.corp.beyondperimeter.com` where "corp.beyondperimeter.com" is your subdomain in your browser, you should see something like the following in your browser and in your terminal. * Included with Pomerium is two test apps [helloworld] and [httpbin]. Pomerium is configured to delegate access to both.
* Navigate to `hello.corp.example.com` or `httpbin.corp.example.com`. You should see something like the following in your browser and in your terminal.
![Getting started](./get-started.gif) ![Getting started](./get-started.gif)
[![asciicast](https://asciinema.org/a/tfbSWkUZgMRxHAQDqmcjjNwUg.svg)](https://asciinema.org/a/tfbSWkUZgMRxHAQDqmcjjNwUg) [![asciicast](https://asciinema.org/a/tfbSWkUZgMRxHAQDqmcjjNwUg.svg)](https://asciinema.org/a/tfbSWkUZgMRxHAQDqmcjjNwUg)
[docker-compose]: (https://docs.docker.com/compose/install/)
[docker]: https://docs.docker.com/install/
[download]: https://github.com/pomerium/pomerium/releases [download]: https://github.com/pomerium/pomerium/releases
[kms]: https://en.wikipedia.org/wiki/Key_management [kms]: https://en.wikipedia.org/wiki/Key_management
[certbot]: https://certbot.eff.org/docs/install.html [certbot]: https://certbot.eff.org/docs/install.html
[script]: https://github.com/pomerium/pomerium/blob/master/scripts/generate_wildcard_cert.sh [script]: https://github.com/pomerium/pomerium/blob/master/scripts/generate_wildcard_cert.sh
[source]: https://github.com/pomerium/pomerium#start-developing [source]: https://github.com/pomerium/pomerium#start-developing
[identity provider]: ./identity-providers.md [identity provider]: ./identity-providers.md
[helloworld]: https://hub.docker.com/r/tutum/hello-world
[httpbin]: https://httpbin.org/
[LetsEncrypt]: https://letsencrypt.org/