Skip to main content

AA ESI Status

Version License Python Django pre-commit pre-commit.ci status Code Style: black Checks codecov Translation status Contributor Covenant Discord Alliance Auth Compatibility

ko-fi

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



Testimonials

Acknowledged By CCP

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

CCP Stroopwafel Testimonial

Screenshots

ESI Status Page

AA ESI Status

Dashboard Widget

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

AA ESI Status Dashboard Widget

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.2.3

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.2.3

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.2.3
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.2.3

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.

Settings

The following settings are available for this app.
You can add them to your local.py file to override the default values.

Setting Type Description Default
ESISTATUS_HISTORY_RETENTION_PERIOD int Retention period for ESI status history in hours. Data older than this period will be removed from the database. 24
ESISTATUS_SHOW_HISTORY_THRESHOLD int Display period for ESI status history in hours. Defines the threshold for the ESI history graph. 24

[!Note]

Keep ESISTATUS_SHOW_HISTORY_THRESHOLD to a sane value. A value too high will result in a very large graph and will cause performance issues.

Lower this value if you experience performance issues when loading the ESI status page.

Changelog

See CHANGELOG.md

Translation Status

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)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aa_esi_status-4.2.3.tar.gz (146.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aa_esi_status-4.2.3-py3-none-any.whl (199.7 kB view details)

Uploaded Python 3

File details

Details for the file aa_esi_status-4.2.3.tar.gz.

File metadata

  • Download URL: aa_esi_status-4.2.3.tar.gz
  • Upload date:
  • Size: 146.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aa_esi_status-4.2.3.tar.gz
Algorithm Hash digest
SHA256 2131344e44ff39d221f2fb5104e9889adbab021b62110d82d0acc083f29b60cd
MD5 66fa6b797178f9d8762f31527eb17df6
BLAKE2b-256 62b3258b923c270838961d8013b2b43e6739e34729f8df7ed2bd6da42a892341

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_esi_status-4.2.3.tar.gz:

Publisher: release.yml on ppfeufer/aa-esi-status

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aa_esi_status-4.2.3-py3-none-any.whl.

File metadata

  • Download URL: aa_esi_status-4.2.3-py3-none-any.whl
  • Upload date:
  • Size: 199.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aa_esi_status-4.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a73ddc16d506ed2d14b0c0feeafb60c3feabcc94f6c9d61c19098707bd883f13
MD5 00677fcc4070fe41c0feea95664d743e
BLAKE2b-256 5d7e3b3c5d39790a4a56b630c2f8dcc4a8dbe8a6e60bdf5d332d09ebc6387cb2

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_esi_status-4.2.3-py3-none-any.whl:

Publisher: release.yml on ppfeufer/aa-esi-status

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

4.2.3 This release

2 files

4.2.2

2 files

4.2.1

2 files

4.2.0

2 files

4.1.1

2 files

4.1.0

2 files

4.0.1

2 files

4.0.0

2 files

3.4.0

2 files

3.3.5

2 files

3.3.4

2 files

3.3.3

2 files

3.3.2

2 files

3.3.1

2 files

3.3.0

2 files

3.2.0

2 files

3.1.0

2 files

3.0.1

2 files

3.0.0

2 files

2.9.3

2 files

2.9.2

2 files

2.9.1

2 files

2.9.0

2 files

2.8.4

2 files

2.8.3

2 files

2.8.2

2 files

2.8.1

2 files

2.8.0

2 files

2.7.0

2 files

2.6.0

2 files

2.5.4

2 files

2.5.3

2 files

2.5.2

2 files

2.5.1

2 files

2.5.0

2 files

2.4.3

2 files

2.4.2

2 files

2.4.1

2 files

2.4.0

2 files

2.3.0

2 files

2.2.1

2 files

2.2.0

2 files

2.1.1

2 files

2.1.0

2 files

2.0.0

2 files

1.14.2

2 files

1.14.1

2 files

1.14.0

2 files

1.13.0

2 files

1.12.1

2 files

1.12.0

2 files

1.11.1

2 files

1.11.0

2 files

1.10.0

2 files

1.9.0

2 files

1.8.0

2 files

1.7.2

2 files

1.7.1

2 files

1.7.0

2 files

1.6.0

2 files

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.0

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page