aa-fleetpings 2.20.0

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

AA Fleet Pings

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

• AA Fleet Pings
  • Installation
    • ⚠️ Important ⚠️
    • Step 1: Install the App
    • Step 2: Update Your AA Settings
    • Step 3: Finalizing the Installation
    • Step 4: Setting up Permission
    • Step 5: Setting up the App
  • Updating
  • Screenshots
    • View in Alliance Auth
    • Discord Ping Example
  • Configuration
    • Use Doctrines From Fittings Module
    • Allow Non Discord Webhooks
  • Changelog
  • Contributing

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're 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: Finalizing the Installation

Copy static files and run migrations

python manage.py collectstatic
python manage.py migrate

Restart your supervisor services for AA

Step 4: Setting up 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: Setting up 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.

Changelog

See CHANGELOG.md

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)