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

deployment : add docker-compose file

Browse source
This commit is contained in:
Bobby DeSimone 2019-01-17 00:08:36 -08:00
parent e41d11f78b
commit 60afad1bd7
No known key found for this signature in database
GPG key ID: AEE4CF12FE86D07E
3 changed files with 28 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -15,11 +15,11 @@ 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.
## Get started ## Get started
For instructions on getting started using Pomerium, see our [docs]. For instructions on getting started using Pomerium, see our [quick start guide].
To learn more about zero-trust and BeyondCorp, check out [awesome-zero-trust].
## Start developing ## Start developing
@ -33,6 +33,6 @@ $ source ./env # see env.example
$ ./bin/pomerium -debug $ ./bin/pomerium -debug
``` ```
[awesome-zero-trust]: https://github.com/pomerium/awesome-zero-trust [resources] : https://github.com/pomerium/awesome-zero-trust
[go environment]: https://golang.org/doc/install [go environment]: https://golang.org/doc/install
[docs]: https://www.pomerium.io [quick start guide]: https://www.pomerium.io/guide/

30
docs/guide/identity-providers.md
View file

@ -41,11 +41,11 @@ Your `Client ID` and `Client Secret` will be displayed:
Set `Client ID` and `Client Secret` in Pomerium's settings. Your [environmental variables] should look something like this. Set `Client ID` and `Client Secret` in Pomerium's settings. Your [environmental variables] should look something like this.
```bash ```bash
export REDIRECT_URL="https://sso-auth.corp.beyondperimeter.com/oauth2/callback" REDIRECT_URL="https://sso-auth.corp.beyondperimeter.com/oauth2/callback"
export IDP_PROVIDER="google" IDP_PROVIDER="google"
export IDP_PROVIDER_URL="https://accounts.google.com" IDP_PROVIDER_URL="https://accounts.google.com"
export IDP_CLIENT_ID="yyyy.apps.googleusercontent.com" IDP_CLIENT_ID="yyyy.apps.googleusercontent.com"
export IDP_CLIENT_SECRET="xxxxxx" IDP_CLIENT_SECRET="xxxxxx"
``` ```
## Okta ## Okta
@ -78,11 +78,11 @@ Go to the **General** page of your app and scroll down to the **Client Credentia
At this point, you will configure the integration from the Pomerium side. Your [environmental variables] should look something like this. At this point, you will configure the integration from the Pomerium side. Your [environmental variables] should look something like this.
```bash ```bash
export REDIRECT_URL="https://sso-auth.corp.beyondperimeter.com/oauth2/callback" REDIRECT_URL="https://sso-auth.corp.beyondperimeter.com/oauth2/callback"
export IDP_PROVIDER="okta" IDP_PROVIDER="okta"
export IDP_PROVIDER_URL="https://dev-108295-admin.oktapreview.com/" IDP_PROVIDER_URL="https://dev-108295-admin.oktapreview.com/"
export IDP_CLIENT_ID="0oairksnr0C0fEJ7l0h7" IDP_CLIENT_ID="0oairksnr0C0fEJ7l0h7"
export IDP_CLIENT_SECRET="xxxxxx" IDP_CLIENT_SECRET="xxxxxx"
``` ```
## Azure ## Azure
@ -151,11 +151,11 @@ At this point, you will configure the integration from the Pomerium side. Your [
```bash ```bash
# Azure # Azure
export REDIRECT_URL="https://sso-auth.corp.beyondperimeter.com/oauth2/callback" REDIRECT_URL="https://sso-auth.corp.beyondperimeter.com/oauth2/callback"
export IDP_PROVIDER="azure" IDP_PROVIDER="azure"
export IDP_PROVIDER_URL="https://login.microsoftonline.com/{REPLACE-ME-SEE-ABOVE}/v2.0" IDP_PROVIDER_URL="https://login.microsoftonline.com/{REPLACE-ME-SEE-ABOVE}/v2.0"
export IDP_CLIENT_ID="REPLACE-ME" IDP_CLIENT_ID="REPLACE-ME"
export IDP_CLIENT_SECRET="REPLACE-ME" IDP_CLIENT_SECRET="REPLACE-ME"
``` ```

16
docs/guide/readme.md
View file

@ -3,14 +3,14 @@
## Using Docker ## Using Docker
1. Install [docker](https://docs.docker.com/install/). * Install [docker](https://docs.docker.com/install/).
1. Install [docker-compose](https://docs.docker.com/compose/install/). * Install [docker-compose](https://docs.docker.com/compose/install/).
1. Save Pomerium's example [`docker-compose.yml`](). * Save Pomerium's example [`docker-compose.yml`]().
1. 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. * 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.
1. Update the compose file with your [identity provider] settings. * Update the compose file with your [identity provider] settings.
1. Copy your subdomain's wild-card TLS certificate next to the compose file. See included [script] to generate one from LetsEncrypt. * Copy your subdomain's wild-card TLS certificate next to the compose file. See included [script] to generate one from LetsEncrypt.
1. Run docker compose by runnig the command `$ docker-compose up`. * Run docker compose by runnig the command `$ docker-compose up`.
1. You should see something like the following in your terminal and in your browser when you navigate to https://hello.corp.beyondperimeter.com or https://httpbin.corp.beyondperimeter.com where "corp.beyondperimeter.com" is your subdomain. * 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.
![Getting started](./get-started.gif) ![Getting started](./get-started.gif)