Skip to main content

Another Fleet Activity Tracking tool for Alliance Auth

Project description

Alliance Auth AFAT — Another Fleet Activity Tracker

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

ko-fi

An Improved FAT/PAP System for Alliance Auth.



Features and Highlights

  • Automatic tracking of participation on FAT links created via ESI
  • Multiple ESI fleets (with your alts)
  • Manually end ESI tracking per fleet
  • Fleet type classification (can be added in the admin backend)
  • Ship type overview per FAT link
  • Graphical statistics views
  • Custom module name
  • Re-open FAT link if the FAT link has expired and is within the defined grace time (only for clickable FAT links)
  • Manually add pilots to clickable FAT links, in case they missed clicking the link (for a period of 24 hours after the FAT links original expiry time)
  • Log for the following actions (Logs are kept for a certain time, 60 days per default):
    • Create FAT link
    • Change FAT link
    • Remove FAT link
    • Re-open FAT link
    • Manually add pilot to FAT link
    • Remove pilot from FAT link

AFAT will work alongside the built-in native FAT System and ImicusFAT. However, data doesn't share, but you can migrate their data to AFAT, for more information, see below.

Screenshots

Dashboard

Dashboard

Fat Link List

Fat Link List

Fat Link Details

Fat Link Details

Add Fat Link View for FCs

Add Fat Link View for FCs

Installation

[!NOTE]

Alliance Auth AFAT >= 3.0.0 needs at least Alliance Auth v4.0.0!

Please make sure to update your Alliance Auth instance before you install this module or update to the latest version, otherwise an update to Alliance Auth will be pulled in unsupervised.

The last version compatible with Alliance Auth v3 is 2.13.0.

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)

For users migrating from one of the other FAT systems, please read the specific instructions FIRST.

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 allianceauth-afat

Step 2: Update Your AA Settings

Configure your AA settings in your local.py as follows:

  • Add 'afat', to INSTALLED_APPS
  • Add the scheduled tasks
# AFAT - https://github.com/ppfeufer/allianceauth-afat
CELERYBEAT_SCHEDULE["afat_update_esi_fatlinks"] = {
    "task": "afat.tasks.update_esi_fatlinks",
    "schedule": crontab(minute="*/1"),
}

CELERYBEAT_SCHEDULE["afat_logrotate"] = {
    "task": "afat.tasks.logrotate",
    "schedule": crontab(minute="0", hour="1"),
}

Step 3: Finalizing the Installation

Run migrations & copy static files

python manage.py collectstatic
python manage.py migrate

Restart your supervisor services for AA.

Updating

To update your existing installation of AFAT, first enable your virtual environment (venv) of your Alliance Auth installation.

pip install -U allianceauth-afat

python manage.py collectstatic
python manage.py migrate

Finally, restart your supervisor services for AA

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

Data Migration

Right after the initial installation and running migrations, you can import the data from Alliance Auth's native FAT system or from ImicusFAT if you have used one of these until now.

Import From Native FAT

To import from the native FAT module, simply run the following command:

python myauth/manage.py afat_import_from_allianceauth_fat

Import From ImicusFAT

To import from the ImicusFAT module, simply run the following command:

python myauth/manage.py afat_import_from_imicusfat

Uninstall ImicusFAT

Now that you've migrated, you can uninstal ImicusFAT.

First, remove all Django migrations for ImicusFAT with:

python manage.py migrate imicusfat zero

This will remove all migrations for ImicusFAT including its DB tables.

Should this command throw an error, a bit of manual labor is needed, but nothing you can't handle, I'm sure.

python manage.py migrate imicusfat zero --fake

And remove all DB tables beginning with imicusfat_ from your DB manually afterwards.

Now that the DB is cleaned up, time to remove te app.

pip uninstall allianceauth-imicusfat

Now remove imicusfat from your INSTALLED_APPS in your local.py, restart supervisor and ... Done!

Settings

To customize the module, the following settings are available.

Name Description Default Value Value Type
AFAT_APP_NAME Custom application name, in case you'd like a different name Fleet Activity Tracking string
AFAT_DEFAULT_FATLINK_EXPIRY_TIME Default expiry time for clickable FAT links in Minutes 60 int
AFAT_DEFAULT_FATLINK_REOPEN_GRACE_TIME Time in minutes a FAT link can be re-opened after it has expired 60 int
AFAT_DEFAULT_FATLINK_REOPEN_DURATION Time in minutes a FAT link is re-opened 60 int
AFAT_DEFAULT_LOG_DURATION Time in days before log entries are being removed from the DB 60 int

Permissions

Name Description Notes
basic_access Can access the AFAT module Your line member probably want this permission, so they can see the module and click the FAT links they are given. They also can see their own statistics with this permission.
manage_afat Can manage the AFAT module Your Military lead probably should get this permission
add_fatlink Can create FAT Links Your regular FC or who ever should be able to add FAT links should have this permission
stats_corporation_own Can see own corporation statistics
stats_corporation_other Can see statistics of other corporations
logs_view Can view the modules logs

Changelog

To keep track of all changes, please read the Changelog.

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

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)

Credits

AFAT is maintained by @ppfeufer and is based on ImicusFAT by @exiom with @Aproia and @ppfeufer which is based on allianceauth-bfat by @colcrunch

Both of these modules are no longer maintained and are deprecated. Both modules will not run with the latest stable releases of Alliance Auth.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

allianceauth_afat-3.0.0.tar.gz (560.4 kB view hashes)

Uploaded Source

Built Distribution

allianceauth_afat-3.0.0-py3-none-any.whl (645.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page