Docker

Prerequisites

You should have the following available on the system you are using to set this up:

Setup Guide

  1. run bash <(curl -s https://gitlab.com/allianceauth/allianceauth/-/raw/master/docker/scripts/download.sh). This will download all the files you need to install Alliance Auth and place them in a directory named aa-docker. Feel free to rename/move this folder.

  2. run ./scripts/prepare-env.sh to set up your environment

  3. (optional) Change PROTOCOL to http:// if not using SSL in .env

  4. run docker-compose --env-file=.env up -d (NOTE: if this command hangs, follow the instructions here)

  5. run docker-compose exec allianceauth bash to open up a terminal inside your auth container

  6. run auth migrate

  7. run auth collectstatic

  8. run auth createsuperuser

  9. visit http://yourdomain:81 to set up nginx proxy manager (NOTE: if this doesn’t work, the machine likely has a firewall. You’ll want to open up ports 80,443, and 81. Instructions for ufw)

  10. login with user admin@example.com and password changeme, then update your password as requested

  11. click on “Proxy Hosts”

  12. click “Add Proxy Host”, with the following settings for auth. The example uses auth.localhost for the domain, but you’ll want to use whatever address you have auth configured on nginx-host

  13. click “Add Proxy Host”, with the following settings for grafana. The example uses grafana.localhost for the domain grafana-host)

Congrats! You should now see auth running at http://auth.yourdomain and grafana at http://grafana.yourdomain!

SSL Guide

Unless you’re running auth locally in docker for testing, you should be using SSL. Thankfully, setting up SSL in nginx Proxy Manager takes about three clicks.

  1. Edit your existing proxy host, and go to the SSL tab. Select “Request a new SSL Certificate” from the drop down.

  2. Now, enable “Force SSL” and “HTTP/2 Support”. (NOTE: Do not enable HSTS unless you know what you’re doing. This will force your domains to only work with SSL enabled, and is cached extremely hard in browsers. ) proxy-manager-ssl

  3. (optional) select “Use a DNS Challenge”. This is not a required option, but it is recommended if you use a supported DNS provider. You’ll then be asked for an API key for the provider you choose. If you use Cloudflare, you’ll probably have issues getting SSL certs unless you use a DNS Challenge.

  4. The email address here will be used to notify you if there are issues renewing your certificates.

  5. Repeat for any other services, like grafana.

That’s it! You should now be able to access your auth install at https://auth.yourdomain

Adding extra packages

There are a handful of ways to add packages:

  • Running pip install in the container

  • Modifying the container’s initial command to install packages

  • Building a custom Docker image (recommended, and less scary than it sounds!)

Using a custom docker image

Using a custom docker image is the preferred approach, as it gives you the stability of packages only changing when you tell them to, along with packages not having to be downloaded every time your container restarts

  1. Add each additional package that you want to install to a single line in conf/requirements.txt. It is recommended, but not required, that you include a version number as well. This will keep your packages from magically updating. You can lookup packages on https://package.wiki, and copy everything after pip install from the top of the page to use the most recent version. It should look something like allianceauth-signal-pings==0.0.7. Every entry in this file should be on a separate line

  2. In docker-compose.yml, comment out the image line under allianceauth (line 36… ish) and uncomment the build section

  3. run docker-compose --env-file=.env up -d, your custom container will be built, and auth will have your new packages. Make sure to follow the package’s instructions on config values that go in local.py

  4. run docker-compose exec allianceauth_gunicorn bash to open up a terminal inside your auth container

  5. run allianceauth update myauth

  6. run auth migrate

  7. run auth collectstatic

NOTE: It is recommended that you put any secret values (API keys, database credentials, etc) in an environment variable instead of hardcoding them into local.py. This gives you the ability to track your config in git without committing passwords. To do this, just add it to your .env file, and then reference in local.py with os.environ.get("SECRET_NAME")

Updating Auth

Base Image

Whether you’re using a custom image or not, the version of auth is dictated by $AA_DOCKER_TAG in your .env file.

  1. To update to a new version of auth, update the version number at the end (or replace the whole value with the tag in the release notes).

  2. run docker-compose pull

  3. run docker-compose --env-file=.env up -d

  4. run docker-compose exec allianceauth bash to open up a terminal inside your auth container

  5. run allianceauth update myauth

  6. run auth migrate

  7. run auth collectstatic

NOTE: If you specify a version of allianceauth in your requirements.txt in a custom image it will override the version from the base image. Not recommended unless you know what you’re doing

Custom Packages

  1. Update the versions in your requirements.txt file

  2. Run docker-compose build

  3. Run docker-compose --env-file=.env up -d