A forward authentication service that provides email verification.
You can find the complete documentation of access-guard at flaeppe.github.io/access-guard.
A simple use case with a protected whoami service
version: "3.8"
services:
traefik:
image: traefik:v2.5
command: |
--providers.docker
--providers.docker.exposedByDefault=false
--log.level=INFO
--accesslog=true
--entryPoints.web.address=:80
ports:
- "80:80"
volumes:
- /var/run/docker.sock:/var/run/docker.sock
whoami:
image: traefik/whoami
labels:
traefik.enable: "true"
traefik.http.routers.whoami.rule: "Host(`whoami.localhost.com`)"
traefik.http.routers.whoami.middlewares: "access-guard@docker"
access-guard:
image: ghcr.io/flaeppe/access-guard
command: [
".*@test\\.com$$",
"--secret", "supersecret",
"--auth-host", "http:https://access-guard.localhost.com/",
"--trusted-hosts", "access-guard", "access-guard.localhost.com",
"--cookie-domain", "localhost.com",
"--email-host", "mailhog",
"--email-port", "1025",
"--from-email", "[email protected]"
]
depends_on:
- mailhog
labels:
traefik.enable: "true"
traefik.http.routers.access-guard.rule: "Host(`access-guard.localhost.com`)"
traefik.http.routers.access-guard.service: "access-guard"
traefik.http.middlewares.access-guard.forwardauth.address: "http:https://access-guard:8585/auth"
traefik.http.services.access-guard.loadbalancer.server.port: "8585"
mailhog:
image: mailhog/mailhog
ports:
- "8025:8025"
A more in depth description of this example can be found in the documentation.
An image named edge
is built and released as soon as code is committed and passed
all automated tests. Expect that there could be immediate issues when running with
this tag.
Use the following to pull the edge
image from command line:
$ docker pull ghcr.io/flaeppe/access-guard:edge
All contributions are welcome. Here's a few useful shortcuts/hints to get you started
make build
Tests are run with pytest
and the whole suite can be run with the following command
make test
Currently the command is quite naive and will run the whole test suite. Although
it's possible to pass flags to pytest
via:
make test test="-k XYZ"
Install and use pre-commit for linting files
make mypy
Intention is to keep it at 100%, because, why not.
For updating/changing of requirements, edit an reqs/*requirement.in
file and run
the following command
make requirements
The documentation can be built locally and served on localhost:8000
with the
following command
make serve-docs
If make sync-local-requirements
is run before this command, all necessary
requirements have been installed
Install requirements locally (tip: prepare and activate a virtualenv before installing)
make sync-local-requirements