aa-sov-timer 4.1.0

Sov Campaign Timer for Alliance Auth

AA Sovereignty Timer

Sovereignty campaign overview for Alliance Auth.

---

• Screenshots
  • All Timers
  • Upcoming Timers (Filtered)
  • Active Timers (Filtered)
• Installation
  • Bare Metal Installation
    • Step 1: Installing the App
    • Step 2: Update Your AA Settings
    • Step 3: Finalizing the Installation
    • Step 4: Preload EVE SDE Data
    • Step 5: Restart Supervisor
  • 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
  • Common Steps / Configuration
    • (Optional) Allow Public Views
• Updating
  • Bare Metal Installation
  • Docker Installation
  • Common Steps
• Changelog
• Translation Status
• Contributing

---

Screenshots

All Timers

Upcoming Timers (Filtered)

Active Timers (Filtered)

Installation

[!IMPORTANT]

Please make sure you meet all preconditions before you proceed.

[!IMPORTANT]

This app is utilising features that are only available in Alliance Auth >= 4.12.0. Please make sure to update your Alliance Auth instance before installing this app, otherwise, an update to Alliance Auth will be pulled in unsupervised.

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

Bare Metal 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==4.1.0

Step 2: Update Your AA Settings

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

• Modify INSTALLED_APPS to include the following entries:

  INSTALLED_APPS += [
      # ...
      "eve_sde",  # Only if not already added for another app
      "sovtimer",
      # ...
  ]
  
  # This line right below the `INSTALLED_APPS` list, and only if not already added for another app
  INSTALLED_APPS = ["modeltranslation"] + INSTALLED_APPS
  

• Add the Scheduled Tasks

  if "sovtimer" in INSTALLED_APPS:
      # 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,
      }
  
  if "eve_sde" in INSTALLED_APPS:
      # Run at 12:00 each day
      CELERYBEAT_SCHEDULE["EVE SDE :: Check for SDE Updates"] = {
          "task": "eve_sde.tasks.check_for_sde_updates",
          "schedule": crontab(minute="0", hour="12"),
      }
  
      # Set the following when you have a bare metal installation, or Docker with a
      # non-standard storage for `myauth`
      ESDE_TASK_SPLIT = True
  

Step 3: Finalizing the Installation

Copy static files and run migrations

python manage.py collectstatic
python manage.py migrate

Step 4: Preload EVE SDE Data

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

python manage.py esde_load_sde
python manage.py sovtimer_load_initial_data

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

Step 5: Restart Supervisor

Once you have completed all previous steps, restart your AA supervisor service to apply the changes.

Continue with the Common Steps / Configuration below to finish the installation.

Docker Installation

Step 1: Add the App

Add the app to your conf/requirements.txt:

aa-sov-timer==4.1.0

Step 2: Update Your AA Settings

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

• Modify INSTALLED_APPS to include the following entries:

  INSTALLED_APPS = [
      # ...
      "eve_sde",  # Only if not already added for another app
      "sovtimer",
      # ...
  ]
  
  # This line right below the `INSTALLED_APPS` list, and only if not already added for another app
  INSTALLED_APPS = ["modeltranslation"] + INSTALLED_APPS
  

• Add the Scheduled Tasks

  if "sovtimer" in INSTALLED_APPS:
      # 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,
      }
  
  if "eve_sde" in INSTALLED_APPS:
      # Run at 12:00 each day
      CELERYBEAT_SCHEDULE["EVE SDE :: Check for SDE Updates"] = {
          "task": "eve_sde.tasks.check_for_sde_updates",
          "schedule": crontab(minute="0", hour="12"),
      }
  
      # Set the following when you have a bare metal installation, or Docker with a
      # non-standard storage for `myauth`
      ESDE_TASK_SPLIT = True
  

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 SDE data:

docker compose exec allianceauth_gunicorn bash

auth collectstatic
auth migrate

auth esde_load_sde
auth sovtimer_load_initial_data

Continue with the Common Steps / Configuration below to finish the installation.

Common Steps / Configuration

(Optional) Allow Public Views

This app supports AA's feature of public views.
To allow this feature, please add "sovtimer",, to the list of APPS_WITH_PUBLIC_VIEWS in your local.py or conf/local.py for Docker:

APPS_WITH_PUBLIC_VIEWS = [
    "sovtimer",
]

[!NOTE]

If you don't have a list for APPS_WITH_PUBLIC_VIEWS yet, then add the whole block from here.

Restart your supervisor service or your Docker containers to apply the changes.

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 aa-sov-timer==4.1.0

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==4.1.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 changelog and/or release notes to find out more.

Changelog

See CHANGELOG.md for a detailed list of changes and improvements.

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)