Skip to main content

Branding & customization plugin for Alliance Auth — custom logos, login backgrounds, favicons, and more.

Project description

AA Customizer

A branding & customization plugin for Alliance Auth.

Gives administrators a simple admin-panel UI to customize their Alliance Auth installation without touching code or replacing static files.

Screenshots

Split Screen layout

Split Screen layout

Centered Card layout (default)

Centered Card layout

Side Bar Icon

Sidebar Icon

Features

Feature What it does
Custom site name Overrides SITE_NAME from local.py across the whole site
Login background URL or uploaded image/video; falls back to a CSS color, then the default AA space background. .mp4, .webm, .ogv URLs play as a fullscreen looping video
Login layout Centered Card, Split Screen (background left), or Split Screen (login left)
Login logo URL or uploaded image shown at the top of the login card
Login title & subtitle Welcome heading and description text on the login card
Login extra HTML Raw HTML injected below the EVE SSO button (notices, Discord links, etc.)
Custom favicon URL or uploaded image replacing all Alliance Auth browser-tab icons
Navbar logo URL or uploaded image alongside the site name in the top navigation bar
Sidebar logo URL or uploaded image replacing the Alliance Auth logo in the sidebar
Custom CSS — URL External stylesheet linked in every page <head>, loaded after the active theme
Custom CSS — inline CSS text injected via <style> on every page, loaded after the active theme
Extra <head> HTML Raw HTML at the end of <head> on every page (analytics, font imports, meta tags)

Requirements

  • Alliance Auth ≥ 4.0.0 (Bootstrap 5 template set)
  • django-solo
  • Pillow

Installation

Bare Metal install

1 — Install the package

# Activate your Alliance Auth virtualenv first, then:
pip install aa-customizer

2 — Add to INSTALLED_APPS

Open your local.py and add above INSTALLED_APPS =:

INSTALLED_APPS.insert(0, 'aa_customizer')

Django searches each app's templates/ folder in INSTALLED_APPS order and uses the first match. Placing aa_customizer first ensures its template overrides are picked up before the Alliance Auth originals.

3 — Add the context processor

In local.py, add to the settings section to append the existing TEMPLATES list:

TEMPLATES[0]["OPTIONS"]["context_processors"].append(
    "aa_customizer.context_processors.aa_customizer"
)

4 — Run migrations

python manage.py migrate aa_customizer

5 — Collect static files

python manage.py collectstatic

6 — (Optional) Configure media file serving

Only needed if you want to use file uploads or the media library instead of image URLs.

Add these two lines anywhere in the Custom Settings section of your local.py:

MEDIA_ROOT = "/path/to/your/media/"
MEDIA_URL  = "/media/"

Make sure your web server (nginx, Apache, etc.) is configured to serve files from MEDIA_ROOT at MEDIA_URL:

    location /media {
        alias /var/www/myauth/media;
        autoindex off;
    }

7 — (Optional) Populate the Media Library

Once media is configured, go to AA Customizer → Media Library in the admin panel to upload images. Give each one a descriptive name (e.g. "Corp logo v2", "Winter background"). You can then pick from your library in Custom Branding without re-uploading — just change the dropdown selection to switch images instantly.

Docker install

The recommended approach for Docker is to use URL fields for all images (point at an external CDN, Imgur, GitHub raw assets, etc.) so you don't need to mount a media volume just to serve a few files.

1 — Install the package inside the container

# Activate your Alliance Auth virtualenv first, then:
pip install aa-customizer

Add aa-customizer to your pip requirements file (e.g. requirements.txt or the equivalent in your Docker setup), then rebuild:

auth migrate
auth collectstatic
exit

2 — Add to INSTALLED_APPS

Open your local.py and add above INSTALLED_APPS =:

INSTALLED_APPS.insert(0, 'aa_customizer')

Django searches each app's templates/ folder in INSTALLED_APPS order and uses the first match. Placing aa_customizer first ensures its template overrides are picked up before the Alliance Auth originals.

3 — Add the context processor

In local.py, add to the settings section to append the existing TEMPLATES list:

TEMPLATES[0]["OPTIONS"]["context_processors"].append(
    "aa_customizer.context_processors.aa_customizer"
)

4 — (Optional) Configure media file serving

If you want to upload images through the admin or use the media library instead of external URLs, follow these steps. For most Docker installs, using URL fields is simpler — just paste an image link and skip all of the below.

a) Add to local.py

Add these two lines anywhere in the Custom Settings section of your local.py:

MEDIA_ROOT = "/var/www/myauth/media/"
MEDIA_URL  = "/media/"

b) Add the named volume to docker-compose.yml

The standard AA Docker setup uses a named Docker volume for media. Add it in three places:

  1. In x-allianceauth-base volumes (so gunicorn, beat, and workers all share it):
x-allianceauth-base: &allianceauth-base
  volumes:
    # ... your existing volume mounts ...
    - media-data:/var/www/myauth/media
  1. In the nginx service volumes:
services:
  nginx:
    volumes:
      # ... your existing volume mounts ...
      - media-data:/var/www/myauth/media
  1. In the top-level volumes: section:
volumes:
  media-data:

c) Configure nginx

In your nginx.conf, add a /media location block inside the server {} block:

location /media {
    alias /var/www/myauth/media;
    autoindex off;
}

d) Bring the stack up

docker compose up -d

e) Fix volume permissions

Docker creates named volumes owned by root. The AA container runs as uid/gid 61000. Run this once after first bringing the stack up:

Confimr the uid/gid

docker compose exec allianceauth_gunicorn ls -la /var/www/myauth/media
#change using
docker compose exec -u root allianceauth_gunicorn chown -R 61000:61000 /var/www/myauth/media

After this, uploads made through /admin/aa_customizer/aacustomizersettings/ will be stored under /var/www/myauth/media/aa_customizer/ and served immediately by nginx.

5 — Build and Restart

docker compose build
docker compose down
docker compose up -d

Usage

  1. Log in to the Alliance Auth admin panel (/admin/).
  2. (Optional) Build your image library — find AA Customizer → Media Library and upload your images there, giving each a name. You can upload as many as you like and switch between them without re-uploading.
  3. Find AA Customizer → Custom Branding in the left-hand sidebar.
  4. For each image slot, choose how to set it:
    • Library — pick from an image you uploaded to the Media Library (recommended when self-hosting media)
    • URL — paste an external link (CDN, Imgur, etc.) — always takes priority
    • Upload — upload a file directly into the field
  5. Fill in any other fields you want and click Save.

Changes take effect immediately on the next page load — no server restart needed.

Field reference

Site

Field Description
Site Name Overrides SITE_NAME from local.py

Login Page — Background

Field Description
Login Background — URL URL of a background image or video (takes priority over everything). Video files (.mp4, .webm, .ogv) play fullscreen, looped, muted, and auto-paused by the browser when the tab is hidden
Login Background — Library Select an image uploaded to the Media Library (takes priority over a direct upload)
Login Background — Upload Upload a background image directly into this field
Login Background Color CSS color fallback when no image is set, or the color shown behind a video while it loads (e.g. #1a1a2e)

Login Page — Layout

Field Description
Login Page Layout Centered Card — login card centered over the full-page background (default). Split Screen — Background Left — background on the left, dark login panel on the right. Split Screen — Login Left — mirrors it.
Split Panel — Show Overlay Text Tick to show text on the background panel; untick to hide it entirely
Split Panel — Overlay Text Text shown on the background panel. Leave blank to auto-display the site name
Split Panel — Text Position Vertical position of the overlay text: Top, Center, or Bottom

Login Page — Branding

Field Description
Login Logo — URL URL of a logo image (takes priority over everything)
Login Logo — Library Select an image from the Media Library (takes priority over a direct upload)
Login Logo — Upload Upload a logo image directly into this field
Login Logo Max Width (px) Maximum display width of the login logo
Login Page Title Custom heading shown above the SSO button
Login Page Subtitle Optional description text below the title
Login Page Extra HTML Raw HTML injected below the EVE SSO button (notices, links, etc.)

Favicon

Field Description
Favicon — URL URL of a favicon image (takes priority over everything)
Favicon — Library Select an image from the Media Library (takes priority over a direct upload)
Favicon — Upload Upload a favicon image directly into this field

Navigation Bar Logo

Field Description
Navbar Logo — URL URL of a navbar logo image (takes priority over everything)
Navbar Logo — Library Select an image from the Media Library (takes priority over a direct upload)
Navbar Logo — Upload Upload a navbar logo image directly into this field
Navbar Logo Height (px) Display height of the navbar logo

Sidebar Logo

Field Description
Sidebar Logo — URL URL of an image to replace the AA logo in the sidebar (takes priority over everything)
Sidebar Logo — Library Select an image from the Media Library (takes priority over a direct upload)
Sidebar Logo — Upload Upload a sidebar logo image directly into this field
Sidebar Logo Width (px) Display width of the sidebar logo

Custom CSS

Field Description
Custom CSS — URL External stylesheet URL linked in every page <head>
Custom CSS Inline CSS injected via <style> on every page

Extra HTML

Field Description
Extra <head> HTML Raw HTML injected at the end of <head> on every page

Image recommendations

Field Recommended size / format
Login background (image) ≥ 1920 × 1080 px, JPEG, PNG, or GIF
Login background (video) 1920 × 1080 px, MP4 (H.264) or WebM (VP9); keep under ~15 MB for fast loads
Login logo ≥ 256 × 256 px, transparent PNG
Favicon ≥ 192 × 192 px, PNG or ICO
Navbar logo Transparent PNG, height ≤ 64 px
Sidebar logo Transparent PNG, width ≤ 256 px

Security notes

  • Raw HTML fields (Login Page Extra HTML, Extra <head> HTML) are rendered without sanitization and are only editable by Django admin users (staff/superusers).
  • Custom CSS URL is validated as a URL by Django's field validator; only http/https schemes are accepted.
  • AA Customizer works alongside Alliance Auth's built-in Custom CSS admin (/admin/custom_css/customcss/). The customizer's CSS loads after the built-in one, so it takes precedence.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aa_customizer-1.1.1.tar.gz (26.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aa_customizer-1.1.1-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

Details for the file aa_customizer-1.1.1.tar.gz.

File metadata

  • Download URL: aa_customizer-1.1.1.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aa_customizer-1.1.1.tar.gz
Algorithm Hash digest
SHA256 82cbba8d094021d8930c4bc9705bae0761a385305c08d063497213e341fe7452
MD5 08623b928fa19e40575811b8cd992c7b
BLAKE2b-256 4c9e5b1b8c39722933fe4dfa0115035a79561b0bd93621849ea5791ce25ca90f

See more details on using hashes here.

File details

Details for the file aa_customizer-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: aa_customizer-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 33.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aa_customizer-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6c3de08b99a516845f5cf61bbe5f179177d59824d4eacc4a4068e5230af4adf8
MD5 5ff3b3d4563f517afe0e6721f58b04cf
BLAKE2b-256 1c23004b5c56f307c112fd506203cbd18836352764e617edf1a2a548603b209f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page