AA Permission Management

Django Permission Management in the Alliance Auth Frontend

• Overview
• Installation
  • Bare Metal Installation
    • Step 1: Install the Module
    • Step 2: Configure Alliance Auth
    • Step 3: Run Static Collection, Migrations, and Restart Alliance Auth
  • Docker Installation
    • Step 1: Add the App
    • Step 2: Configure Alliance Auth
    • Step 3: Build Auth and Restart Your Containers
    • Step 4: Finalize the Installation
• Changelog
• Translation Status
• Contributing

Overview

This module provides a user interface for managing permissions within the Alliance Auth application. It allows to assign and revoke permissions for groups, and states.

For EVE Online alliances, the number of people in a group or state can grow quite large, which can lead to performance issues when trying to manage permissions through the admin backend. This module provides a more efficient way to manage permissions for large groups and states in the Alliance Auth frontend.

[!WARNING]

This module provides a user interface for managing permissions, which is an administrative task.
Please ensure to only grant access to this module to trusted users!

Installation

To install the AA Permission Management module, follow these steps:

Bare Metal Installation

Step 1: Install the Module

Make sure you're in the virtual environment (venv) of your Alliance Auth installation Then install the latest release directly from PyPi.

pip install aa-permission-management==1.2.0

Step 2: Configure Alliance Auth

Add aa_permission_management to the INSTALLED_APPS in your local.py file.

INSTALLED_APPS += [
    # ...
    "aa_permission_management",  # https://github.com/ppfeufer/aa-permission-management
    # ...
]

Step 3: Run Static Collection, Migrations, and Restart Alliance Auth

After adding the module to your configuration, run the following commands:

python manage.py collectstatic --noinput
python manage.py migrate aa_permission_management

sudo systemctl restart supervisor

Docker Installation

Step 1: Add the App

Add the app to your conf/requirements.txt:

aa-permission-management==1.2.0

Step 2: Configure Alliance Auth

Add aa_permission_management to the INSTALLED_APPS in your local.py file.

INSTALLED_APPS += [
    # ...
    "aa_permission_management",  # https://github.com/ppfeufer/aa-permission-management
    # ...
]

Step 3: Build Auth and Restart Your Containers

After adding the module to your requirements and updating the configuration, build your Docker images and restart your containers to apply the changes.

docker compose build --no-cache
docker compose --env-file=.env up -d

Step 4: Finalize the Installation

After the containers are up and running, run the migrations for the new module.

docker compose exec allianceauth_gunicorn bash

auth collectstatic
auth migrate

Changelog

See CHANGELOG.md

Translation Status

Do you want to help translate this app into your language or improve the existing translation? - Join our team of translators!

Contributing

You want to contribute to this project? That's cool!

Please make sure to read the Contribution Guidelines.
(I promise, it's not much, just some basics)