aa-sov-timer

AA Sovereignty Timer

Sovereignty campaign overview for Alliance Auth.

• Screenshots
  • AA Sov Timer Dashboard
• Installation
  • Bare Metaal Installation
    • Step 1: Installing the App
    • Step 2: Update Your AA Settings
    • Step 3: Finalizing the Installation
    • Step 4: Preload Eve Universe Data
    • Step 5: Setting up Permission
    • Step 6: Keep Campaigns Updated
  • Docker Installation
    • Step 1: Add the App
    • Step 2: Update Your AA Settings
    • Step 3: Build Auth and Restart Your Containers
    • Step 4: Finalizing the Installation
• Updating
  • Bare Metal Installation
  • Docker Installation
  • Common Steps
• Changelog
• Translation Status
• Contributing

Screenshots

AA Sov Timer Dashboard

Installation

[!IMPORTANT]

Please make sure you meet all preconditions before you proceed.

• AA Sovereignty Timer is a plugin for Alliance Auth. If you don't have Alliance Auth running already, please install it first before proceeding. (see the official AA installation guide for details)
• AA Sovereignty Timer needs the app django-eveuniverse to function. Please make sure it is installed before continuing.

Bare Metaal Installation

Step 1: Installing the App

Make sure you're in the virtual environment (venv) of your Alliance Auth installation. Then install the latest version:

pip install aa-sov-timer

Step 2: Update Your AA Settings

Configure your AA settings (local.py) as follows:

• Add 'eveuniverse', to INSTALLED_APPS if not already done for another app
• Add 'sovtimer', to INSTALLED_APPS

Restart your supervisor

Step 3: Finalizing the Installation

Copy static files and run migrations

python manage.py collectstatic
python manage.py migrate

Step 4: Preload Eve Universe Data

AA Sovereignty Timer uses Eve Universe data to map IDs to names for solar systems, regions and constellations. So you need to preload some data from ESI once. If you already have run this command, you can skip this step.

python manage.py eveuniverse_load_data map
python manage.py sovtimer_load_initial_data

Both commands might take a moment or two, so be patient ...

Step 5: Setting up Permission

Now you can set up permissions in Alliance Auth for your users. Add sovtimer | Sovereignty Timer | Can access the Sovereignty Timer module to the states and/or groups you would like to have access.

Step 6: Keep Campaigns Updated

Add the following scheduled task to your local.py. One done, restart your supervisor.

# AA Sovereignty Timer - Run sovereignty related updates every 30 seconds
CELERYBEAT_SCHEDULE["sovtimer.tasks.run_sov_campaign_updates"] = {
    "task": "sovtimer.tasks.run_sov_campaign_updates",
    "schedule": 30.0,
}

Now your system is updating the sovereignty campaigns every 30 seconds.

Docker Installation

Step 1: Add the App

Add the app to your conf/requirements.txt:

aa-sov-timer==2.5.0

Step 2: Update Your AA Settings

Configure your AA settings (conf/local.py) as follows:

• Add 'eveuniverse', to INSTALLED_APPS if not already done for another app
• Add 'sovtimer', to INSTALLED_APPS
• Add the Scheduled Task

# AA Sovereignty Timer - Run sovereignty related updates every 30 seconds
CELERYBEAT_SCHEDULE["sovtimer.tasks.run_sov_campaign_updates"] = {
    "task": "sovtimer.tasks.run_sov_campaign_updates",
    "schedule": 30.0,
}

Step 3: Build Auth and Restart Your Containers

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

Step 4: Finalizing the Installation

Run migrations, copy static files and load EVE universe data:

docker compose exec allianceauth_gunicorn bash

auth collectstatic
auth migrate

auth eveuniverse_load_data map
auth sovtimer_load_initial_data

Updating

Bare Metal Installation

To update your existing installation of AA Sovereignty Timer, first enable your virtual environment.

Then run the following commands from your AA project directory (the one that contains manage.py).

pip install -U aa-sov-timer

python manage.py collectstatic
python manage.py migrate

Finally, restart your AA supervisor service.

Docker Installation

To update your existing installation of AA Sovereignty Timer, all you need to do is to update the respective line in your conf/requirements.txt file to the latest version.

aa-sov-timer==2.5.0

Now rebuild your containers and restart them:

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

After that, run the following commands to update your database and static files:

docker compose exec allianceauth_gunicorn bash

auth collectstatic
auth migrate

Common Steps

It is possible that some versions need some more changes. Always read the release notes to find out more.

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

Do 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)