pomerium/docs/docs/install/readme.md
Alex Fornuto 64d50613af
DOCS: keyword tag updates (#2922)
* replace "zero-trust" with "zero trust"

* fix and update all keyword tags
2022-01-11 12:36:47 -06:00

3 KiB

title lang description meta
Quick-Start en-US Get Pomerium up and running quickly with Docker.
name content
keywords pomerium, identity access proxy, oidc, docker, reverse proxy, containers, identity aware proxy

Pomerium using Docker

In this quick-start document, we'll create a minimal but complete environment for running Pomerium with containers.

Prerequisites

Configure

  1. Create a configuration file (e.g config.yaml) for defining Pomerium's configuration settings, routes, and access policies. Consider the following example:

    <<< @/examples/config/config.docker.yaml

    Keep track of the path to this file, relative to the docker-compose.yml file created in the next step. docker-compose.yml will need the correct relative path to your config.yaml.

  2. Create or copy the following docker-compose.yml file and modify it to match your configuration, including the correct paths to your config.yaml and certificate files:

    <<< @/examples/docker/basic.docker-compose.yml

Run

Run docker compose:

docker-compose up

Docker will automatically download the required container images for Pomerium and verify. Then, Pomerium will run with the configuration details set in the previous steps.

You should now be able access to the routes (e.g. https://verify.localhost.pomerium.io) as specified in your policy file.

You can also navigate to the special pomerium endpoint verify.localhost.pomerium.io/.pomerium/ to see your current user details.

currently logged in user

Next Steps

Now you can experiment with adding services to Docker and defining routes and policies for them in Pomerium. See Guides for help or inspiration.

::: warning This is a test environment! If you followed all the steps in this doc your Pomerium environment is not using trusted certificates. Remember to use a valid certificate solution before moving this configuration to a production environment. See Certificates for more information. :::