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 PyPI Downloads Code Style: black

App for formatting pings for Discord and Slack in Alliance Auth

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 1 - Install 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 permissions

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.

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

Discord Ping Examples

(Example for embedded ping (top) and non embedded ping (bottom))

Configuration

Using Slack instead of Discord?

Don't worrie, 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?)

Project details


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.0.0a5.tar.gz (501.8 kB view hashes)

Uploaded Source

Built Distribution

aa_fleetpings-2.0.0a5-py3-none-any.whl (510.2 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