Fleet Ping Tool for Alliance Auth supporting pings via webhooks to Discord and Slack.
Project description
AA Fleet Pings
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)
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',
toINSTALLED_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
Discord Ping Examples
Not embedded
Embedded
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
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aa_fleetpings-2.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48f3854ec22209fc8c47045506999cc1f841e2581d09c9d211931089ff6827b5 |
|
MD5 | b4f6afbe98eddb7ef3a5c597be555855 |
|
BLAKE2b-256 | 904c5d9daa1565659c7b1a5c0465f0c42bba50afa5728e6fa6826cb1c9edc121 |