Install & Compatibility
Where this runs
tested against v? · pip install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.920 runs
build_error
glibcpy 3.10–3.920 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
Django URL patterns for Alliance Auth
✓ from django.urls import include, path
urlpatterns = [
path('', include('allianceauth.urls')),
# ... other app URLs
]
Alliance Auth is typically included as a full Django application. Its URLs are included in your project's main urls.py.
Adding Alliance Auth to INSTALLED_APPS
✓ INSTALLED_APPS = [
# ... other Django/community apps
'allianceauth',
'allianceauth.authentication',
'allianceauth.eveonline',
# ... other required Alliance Auth apps
]
The core 'allianceauth' and its sub-applications are added to Django's INSTALLED_APPS in settings/local.py to enable functionality.
This quickstart outlines the essential steps to initialize a new Alliance Auth project, install its dependencies, configure basic settings, perform database migrations, create an administrative user, and run the development server. For production, Gunicorn and Supervisor are recommended for managing the application and background tasks.
# Assuming Python 3.x and a virtual environment are active, and system dependencies (DB, Redis) are installed.
# 1. Install Alliance Auth and recommended WSGI server/monitoring tools
pip install allianceauth gunicorn superlance
# 2. Create your Alliance Auth project (replace 'myauth' with your desired project name)
allianceauth start myauth
# 3. Navigate into the new project directory
cd myauth
# 4. Configure your EVE SSO application and database settings
# Edit myauth/settings/local.py to set EVE_CLIENT_ID, EVE_SECRET_KEY, EVE_CALLBACK_URL,
# and configure your DATABASES and EMAIL_URL.
# 5. Run database migrations
python manage.py migrate
# 6. Create an admin superuser
python manage.py createsuperuser
# 7. Collect static files
python manage.py collectstatic --noinput
# 8. Start the development server (for testing only, use gunicorn/supervisor for production)
python manage.py runserver 0.0.0.0:8000
# Access your site at http://localhost:8000 and log in with your superuser account via /admin.
allianceauth --version
Debug
Known issues
breakingUpcoming v5.0.0 introduces significant breaking changes: drops Python 3.8/3.9 support, requires Django 5.2, uses Django-ESI v9 (dropping Swagger Client), removes legacy XMLAPI code and Bootstrap 3 templates. Community apps will need updates for compatibility.fixReview the official v5.0.0 release notes and migration guides thoroughly. Update Python, Django, and all community applications to compatible versions before upgrading the core Alliance Auth instance.
affects: >=5.0.0 (beta versions already released)
gotchaAvoid using 'sudo' for pip installs or management commands within your virtual environment, as it can lead to permission issues and break the environment's integrity.fixAlways activate your virtual environment (e.g., `source /path/to/venv/bin/activate`) and run commands as the unprivileged user designated for Alliance Auth. Only use `sudo` for system-level package management or when explicitly instructed for specific server configurations.
affects: All versions
gotchaUsing MariaDB versions prior to 10.2.x can result in a 'Specified key was too long error' during database migrations, due to incompatibilities with Django's default index lengths.fixEnsure your MariaDB installation is version 10.2.x or newer. Alternatively, use a different supported Django database (e.g., PostgreSQL, MySQL 5.7+).
affects: <4.x when using MariaDB <10.2
gotchaWhen updating Alliance Auth, especially across major versions, ensure all installed community applications are compatible. Incompatible apps can break your Auth installation or cause unexpected behavior.fixAlways check the changelogs and update instructions for both Alliance Auth and all your installed community apps before performing an upgrade. Pin app versions in `requirements.txt` to prevent unsupervised breaking upgrades.
affects: All versions, particularly major upgrades (e.g., 3.x to 4.x, 4.x to 5.x)
Upgrade
Version history
5.1.4latest on PyPI · released Jun 3, 2026
Audit
Dependencies
PythonrequiredRequires Python 3.8 to <3.13 for version 4.x. Upcoming v5.x will drop 3.8/3.9 and target 3.12/3.13.
DjangorequiredAlliance Auth is a Django application framework. v4.x supports Django up to 4.2.x; v5.x will require Django 5.2.
MariaDB/MySQL or PostgreSQLrequiredA robust database is required for production. SQLite is available for development but not recommended for production.
RedisrequiredUsed for caching and Celery task queue management.