pomerium/docs/guide/from-source.md
2019-04-27 20:21:43 -07:00

2.3 KiB

From source

Prerequisites

Download

Retrieve the latest copy of pomerium's source code by cloning the repository.

git clone https://github.com/pomerium/pomerium.git $HOME/pomerium

Make

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

Environmental Configuration Variables

Create a environmental configuration file modify its configuration to to match your identity provider settings. For example, env:

<<< @/env.example

policy.yaml

Next, create a policy configuration file which will contain the routes you want to proxy, and their desired access-controls. For example, policy.example.yaml:

<<< @/policy.example.yaml

Certificates

Place your domain'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

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

source ./env
./bin/pomerium

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

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

Navigate

Browse to httpbin.your.domain.com. You should see something like the following in your browser.

Getting started