pomerium/docs/guide

Quick start

Using Docker

• Install docker and docker-compose.
• Grab Pomerium's included example 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.
• Pomerium is configured to delegate access to two test apps helloworld and httpbin. 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.

From source

Get the code

Using git, retrieve the latest copy of pomerium's source code by cloning the repository.

# where `$HOME/pomerium` is the directory you want to save pomerium
git clone https://github.com/pomerium/pomerium.git $HOME/pomerium

Build pomerium from source in a single step using make.

cd $HOME/pomerium
make

The command 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.

Configure

Make a copy of the env.example and name it something like env.

cp env.example env

Modify your env configuration to to match your identity provider settings.

vim env

Run

Finally, source the the configuration env file and run pomerium.

source ./env
./bin/pomerium

All-in-one

Assuming your configuration file ready to go, you can simply use this one-liner.

make && source ./env && ./bin/pomerium