Skip to main content

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

Project description

AA Fleet Pings

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

ko-fi

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', 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 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

View in Alliance Auth

Discord Ping Example

Discord Ping Example

Configuration

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

aa_fleetpings-2.16.0.tar.gz (412.5 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.16.0-py3-none-any.whl (422.6 kB view details)

Uploaded Python 3

File details

Details for the file aa_fleetpings-2.16.0.tar.gz.

File metadata

  • Download URL: aa_fleetpings-2.16.0.tar.gz
  • Upload date:
  • Size: 412.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for aa_fleetpings-2.16.0.tar.gz
Algorithm Hash digest
SHA256 dfb59348a5c490df1eefdb380bdc94d36045ac07fb45aa97c8731e43a046064d
MD5 9ee5ca01301b14e192c92a237a2ce9a8
BLAKE2b-256 3993fd5e4531cdb8ab9128af96c61ed28780372f657a08bf9e6a6209beaedcc2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aa_fleetpings-2.16.0-py3-none-any.whl
  • Upload date:
  • Size: 422.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for aa_fleetpings-2.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 04215fd97c67ed13d1d247396e857b5724bedec8e46c32e544799dd24063eab7
MD5 371bee583c5cffa76b7d5c44263ed616
BLAKE2b-256 8e6f733fde6c961ba60dc51a58126ac651bb9c80b84d3d1c2c6877ff2bc9dd8c

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