Skip to main content

Fleet Ping Tool for Alliance Auth supporting pings via webhooks to Discord and Slack.

Project description

AA Fleet Pings

Version License Python Django pre-commit Code Style: black Discord Checks codecov Contributor Covenant

App for Alliance Auth that can format your fleet pings and also ping for you to Discord and Slack.

Formerly known as AA Discord Ping Formatter.

Since the original app evolved and with the now added support to ping Slack as well, I felt the name was no longer fitting, so I re-branded the app as "AA Fleet Pings". The old Discord ping formatter will be discontinued in favor of this one.

If you used the old app until now (not the alpha versions), don't worry, nothing is breaking. At least I hope so. Since this app has a complete new code base and a different name it shouldn't interfere with the old one. All you need to do is to set the new permission for the groups that need to have access to this app.

If you run into any trouble, feel free to shout at me on the Alliance Auth Support Discord. You find me there as Rounon Dax.

Contents

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)

⚠️ You also want to make sure that you have the Discord service installed, configured and activated before installing this app. ⚠️

Step 0 - Migrating from AA Discord Ping Formatter

If you have been using the old Discord Ping Formatter until now, it is pretty easy to migrate.

First you have to remove the old app.

python manage.py migrate discordpingformatter zero
pip uninstall aa-discord-ping-formatter

After this, just remove the 'discordpingformatter', line from your INSTALLED_APPS in your local.py. Once done, feel free to install this app by following the steps above.

Step 1 - Install the app

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

pip install aa-fleetpings

Step 2 - Update your AA settings

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

  • Add 'fleetpings', to INSTALLED_APPS

Step 3 - Finalize the installation

Copy static files and run migrations

python manage.py collectstatic
python manage.py migrate

Restart your supervisor services for AA

Step 4 - Setup permission

Now you can setup permissions in Alliance Auth for your users. Add fleetpings | aa fleet pings | Can access this app to the states and/or groups you would like to have access.

Step 5 - Setup the app

In your admin backend you'll find a new section called Fleet Pings. This is where you set all your stuff up, like the webhooks you want to ping and who can ping them, fleet types, comms, formup locations and so on. It's pretty straight forward, so you shouldn't have any issues. Go nuts!

Updating

To update your existing installation of AA Discord Ping Formatter 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-fleetpings
python manage.py collectstatic
python manage.py migrate

Finally restart your AA supervisor services.

Screenshots

View in Alliance Auth

AA View

Discord Ping Examples

Not embedded

Discord Ping No Embed

Embedded

Discord Ping Embed

Configuration

Using Slack instead of Discord?

Don't worry, I don't judge and you still can use this module. It supports also pings to Slack. Simply add the following to your local.py.

## AA Fleet Pings
AA_FLEETPINGS_USE_SLACK = True

Although you cannot use your Auth groups as targets for pings with Slack. Auth doesn't supprt Slack as of yet. (Maybe if someone writes a service?)

Slack Ping Example

Slack Ping

Use Doctrines from Fittings module

If you have the Fittings and Doctrines module installed, and your doctrines configured there, you don't have to re-build your doctrine list for this module. You can simply use the doctrines you already have configured in the Fittings and Doctrines module.

To do so, add the following to your local.py:

## AA Fleet Pings
AA_FLEETPINGS_USE_DOCTRINES_FROM_FITTINGS_MODULE = True

Project details


Release history Release notifications | RSS feed

This version

2.8.0

Download files

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

Source Distribution

aa-fleetpings-2.8.0.tar.gz (597.9 kB view details)

Uploaded Source

Built Distribution

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

aa_fleetpings-2.8.0-py3-none-any.whl (614.8 kB view details)

Uploaded Python 3

File details

Details for the file aa-fleetpings-2.8.0.tar.gz.

File metadata

  • Download URL: aa-fleetpings-2.8.0.tar.gz
  • Upload date:
  • Size: 597.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for aa-fleetpings-2.8.0.tar.gz
Algorithm Hash digest
SHA256 63c52573dc3797c0667cffd0885fee329780559aa153de2749c47e1dd3c99045
MD5 ca022d170e04d722677c5003c48d6718
BLAKE2b-256 6f4353ce4e45ae524845710ece83ebcc43cda4ace54d61a02784733d8fd431ce

See more details on using hashes here.

File details

Details for the file aa_fleetpings-2.8.0-py3-none-any.whl.

File metadata

  • Download URL: aa_fleetpings-2.8.0-py3-none-any.whl
  • Upload date:
  • Size: 614.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for aa_fleetpings-2.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 591fc124c8739b70d945a527cb931e84073422be8bac328be600180a67542815
MD5 7687901dc290eb3c54b4815ff4e8f1b6
BLAKE2b-256 703cdd97529a4fd562e7e4710006b08c162f2a84b9bad0588f454e4a87ed2342

See more details on using hashes here.

Supported by

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