From b312357c01c9e5353c2e6eb377e14cdd1dca1a60 Mon Sep 17 00:00:00 2001 From: Bobby DeSimone Date: Thu, 17 Jan 2019 09:20:16 -0800 Subject: [PATCH] docs : update readme and quickstart --- README.md | 2 +- docs/guide/readme.md | 20 ++++++++++++-------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ab7eef0d9..fcbe798a4 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Use Pomerium to: - deploy mutual authenticated encryption (mTLS). - 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 diff --git a/docs/guide/readme.md b/docs/guide/readme.md index 093c59e83..d84316aa4 100644 --- a/docs/guide/readme.md +++ b/docs/guide/readme.md @@ -3,22 +3,26 @@ ## Using Docker -* Install [docker](https://docs.docker.com/install/). -* Install [docker-compose](https://docs.docker.com/compose/install/). -* Save Pomerium's example [`docker-compose.yml`](). -* 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. -* 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. +* Install [docker] and [docker-compose]. +* Grab Pomerium's included example [`docker-compose.yml`](https://raw.githubusercontent.com/pomerium/pomerium/master/docker-compose.yml) directly or by cloning the repository. +* Update `docker-compose.yml` to match your [identity provider] settings. +* 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]. * 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) [![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 [kms]: https://en.wikipedia.org/wiki/Key_management [certbot]: https://certbot.eff.org/docs/install.html [script]: https://github.com/pomerium/pomerium/blob/master/scripts/generate_wildcard_cert.sh [source]: https://github.com/pomerium/pomerium#start-developing -[identity provider]: ./identity-providers.md \ No newline at end of file +[identity provider]: ./identity-providers.md +[helloworld]: https://hub.docker.com/r/tutum/hello-world +[httpbin]: https://httpbin.org/ +[LetsEncrypt]: https://letsencrypt.org/ \ No newline at end of file