AA ESI Status

App for Alliance Auth to show the current status of ESI and its end points.

• Testimonials
  • Acknowledged By CCP
• Screenshots
  • ESI Status Page
  • Dashboard Widget
• Installation
  • Bare Metal Installation
    • Step 1: Install the App
    • Step 2: Update Your AA Settings
    • Step 3: Finalizing the Installation
  • 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
    • (Optional) Public Views
• Updating
  • Bare Metal Installation
  • Docker Installation
  • Common Steps
• Changelog
• Translation Status
• Contributing

Testimonials

Acknowledged By CCP

This app is so good, that after 5 years of its existence, CCP finally acknowledged its superiority and copied it.

Screenshots

ESI Status Page

Dashboard Widget

This is how the dashboard widget looks like. It shows the current status of ESI for administrative users.

Installation

[!Important]

This app 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: Install the App

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

pip install aa-esi-status==4.1.0

Step 2: Update Your AA Settings

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

• Add "esistatus", to INSTALLED_APPS

INSTALLED_APPS += [
    "esistatus",  # https://github.com/ppfeufer/aa-esi-status
]

• Add the scheduled task

# AA ESI Status - https://github.com/ppfeufer/aa-esi-status
CELERYBEAT_SCHEDULE["ESI Status :: Update"] = {
    "task": "esistatus.tasks.update_esi_status",
    "schedule": 60,
}

Step 3: Finalizing the Installation

Run migrations & copy static files.

python manage.py collectstatic
python manage.py migrate

Restart your supervisor services for AA.

Docker Installation

Step 1: Add the App

Add the app to your conf/requirements.txt:

aa-esi-status==4.1.0

Step 2: Update Your AA Settings

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

• Add "esistatus", to INSTALLED_APPS

INSTALLED_APPS += [
    "esistatus",  # https://github.com/ppfeufer/aa-esi-status
]

• Add the scheduled task

# AA ESI Status - https://github.com/ppfeufer/aa-esi-status
CELERYBEAT_SCHEDULE["ESI Status :: Update"] = {
    "task": "esistatus.tasks.update_esi_status",
    "schedule": 60,
}

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

Common Steps

(Optional) Public Views

This app supports AA's feature of public views, since the ESI status is not any mission-critical information. To allow users to view the time zone conversion page without the need to log in, please add "esistatus", to the list of APPS_WITH_PUBLIC_VIEWS in your local.py:

# By default, apps are prevented from having public views for security reasons.
# To allow specific apps to have public views, add them to APPS_WITH_PUBLIC_VIEWS
#   » The format is the same as in INSTALLED_APPS
#   » The app developer must also explicitly allow public views for their app
APPS_WITH_PUBLIC_VIEWS = [
    "esistatus",  # https://github.com/ppfeufer/aa-esi-status/
]

Note

If you don't have a list for APPS_WITH_PUBLIC_VIEWS yet, then add the whole block from here. This feature has been added in Alliance Auth v3.6.0 so you might not yet have this list in your local.py.

Updating

Bare Metal Installation

To update your existing installation of AA ESI Status, first enable your virtual environment.

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

pip install aa-esi-status==4.1.0
python manage.py collectstatic
python manage.py migrate

Now restart your AA supervisor services.

Docker Installation

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

aa-esi-status==4.1.0

Now rebuild your containers:

docker compose build
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)