mirrors
/
authentik
mirror of https://github.com/goauthentik/authentik.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
authentik/website/docs/installation/docker-compose.md

3.5 KiB
Raw Blame History

title
docker-compose installation

This installation method is for test-setups and small-scale productive setups.

Requirements

  • A Linux host with at least 2 CPU cores and 2 GB of RAM.
  • docker
  • docker-compose

Preparation

Download the latest docker-compose.yml from here. Place it in a directory of your choice.

To optionally deploy a different version run echo AUTHENTIK_TAG=2021.12.2 >> .env

If this is a fresh authentik install run the following commands to generate a password:

# You can also use openssl instead: `openssl rand -base64 36`
sudo apt-get install -y pwgen
# Because of a PostgreSQL limitation, only passwords up to 99 chars are supported
# See https://www.postgresql.org/message-id/09512C4F-8CB9-4021-B455-EF4C4F0D55A0@amazon.com
echo "PG_PASS=$(pwgen 40 1)" >> .env
echo "AUTHENTIK_SECRET_KEY=$(pwgen 50 1)" >> .env
# Skip if you don't want to enable error reporting
echo "AUTHENTIK_ERROR_REPORTING__ENABLED=true" >> .env

Email configuration (optional, but recommended)

It is also recommended to configure global email credentials. These are used by authentik to notify you about alerts and configuration issues. They can also be used by Email stages to send verification/recovery emails.

Append this block to your .env file

# SMTP Host Emails are sent to
AUTHENTIK_EMAIL__HOST=localhost
AUTHENTIK_EMAIL__PORT=25
# Optionally authenticate (don't add quotation marks to you password)
AUTHENTIK_EMAIL__USERNAME=
AUTHENTIK_EMAIL__PASSWORD=
# Use StartTLS
AUTHENTIK_EMAIL__USE_TLS=false
# Use SSL
AUTHENTIK_EMAIL__USE_SSL=false
AUTHENTIK_EMAIL__TIMEOUT=10
# Email address authentik will send from, should have a correct @domain
AUTHENTIK_EMAIL__FROM=authentik@localhost

GeoIP configuration (optional)

authentik can use a MaxMind-formatted GeoIP Database to extract location data from IPs. You can then use this location data in policies, and location data is saved in events.

To configure GeoIP, sign up for a free MaxMind account here.

After you have your account ID and license key, add the following block to your .env file:

GEOIPUPDATE_ACCOUNT_ID=*your account ID*
GEOIPUPDATE_LICENSE_KEY=* your license key*
AUTHENTIK_AUTHENTIK__GEOIP=/geoip/GeoLite2-City.mmdb

The GeoIP database will automatically be updated every 8 hours.

Startup

Afterwards, run these commands to finish

docker-compose pull
docker-compose up -d

The compose file statically references the latest version available at the time of downloading the compose file, which can be overridden with the AUTHENTIK_TAG environment variable.

authentik will then be reachable on port 9000 (HTTP) and port 9443 (HTTPS).

To start the initial setup, navigate to https://<your server>/if/flow/initial-setup/. There you will be prompted to set a password for the akadmin user.

Explanation

The docker-compose project contains the following containers:

  • server

    This is the backend service, which does all the logic, runs the API and the actual SSO part. It also runs the frontend, hosts the JS/CSS files, and also serves the files you've uploaded for icons/etc.

  • worker

    This container executes background tasks, everything you can see on the System Tasks page in the frontend.

  • redis & postgresql

    Cache and database respectively.

Additionally, if you've enabled GeoIP, there is a container running that regularly updates the GeoIP database.