Portier Broker

by portier

GitHub Readme.md

Portier Broker

This is the Portier Broker reference implementation.

How to run your own broker

HerokuDeploy

Portier is specified such that everyone can run their own broker instance. You can point your Relying Parties at your own broker, so that you do not have to depend on the broker run by the Portier project.

Binaries for the broker can be found on the GitHub releases page. Docker images are also available on Docker Hub. Alternatively, you can build the broker yourself.

The broker can be configured using a configuration file or through environment variables. Both are documented in the example configuration file.

Once you've prepared the configuration, simply run the broker executable:

# From binaries:
./portier-broker[.exe] ./config.toml

# Using Docker:
docker run -v /srv/portier-broker:/data:ro portier/broker /data/config.toml

Some additional notes:

  • If using environment variables only, don't specify a configuration file on the command line.

  • Systemd units are also included with the Linux binaries.

  • The broker only talks plain HTTP, and not HTTPS. Using HTTPS is strongly recommended, but you'll need to add a reverse proxy in front of the broker to do this. (Apache or Nginx can do this for you.)