pomerium/docs/guide/from-source.md
Bobby DeSimone bcecee5ee3
docs: add kubernetes (#33)
- Update PR template to use Go language conventions.
- Moved healthcheck middleware to hijack a request before logging.
- Rewrote the quickstart guides to follow a similar pattern.
- Added an overview blurb on pomerium and its goals.
- Add an "example config" section to docs.
2019-01-27 22:22:14 -08:00

2 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

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

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