Fleet Ping Tool for Alliance Auth supporting pings via webhooks to Discord.
Project description
AA Fleet Pings
App for Alliance Auth that can format your fleet pings and also ping for you to Discord.
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 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 set up permissions in Alliance Auth for your users.
Add fleetpings | aa fleetpings | 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 Example
Configuration
The following settings can be made in your local.py
:
Setting | Description | Default |
---|---|---|
AA_FLEETPINGS_USE_DOCTRINES_FROM_FITTINGS_MODULE |
Enables integration with the Fittings and Doctrines module for doctrine suggestion. | False |
AA_FLEETPINGS_WEBHOOK_VERIFICATION |
Enables or disables verification of webhook URLs to see if it's a valid Discord webhook | True |
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
Allow Non Discord Webhooks
If you require your pings to be sent to a webhook that is not a standard discord
webhook, add the following to your local.py
:
## AA Fleet Pings
AA_FLEETPINGS_WEBHOOK_VERIFICATION = False
When disabling webhook verification and using non Discord webhooks, it is up to you to make sure your webhook understands a payload that is formatted for Discord webhooks.
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.17.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d1c944895832f7952967b85282ab1cc66768dd01b7d931a0befb9e46e31d79d |
|
MD5 | fd76aca9216be3665113affe52226856 |
|
BLAKE2b-256 | 47e99cb2b206e7b6e2c72083c699e2d30fec56735a2b4be8a045dde84321006b |