Fleet Pings
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 ping for you to Discord.
<hr />- Screenshots
- View in Alliance Auth
- Discord Ping Examples
- Installation
- Bare Metal Installation
- Docker Installation
- Common Setup Steps
- Updating
- Bare Metal Installation
- Docker Installation
- Configuration
- Use Default Fleet Types
- Use Default Ping Targets
- Use Doctrines From Fittings Module
- Webhook Verification
- Default Embed Color
- Changelog
- Translation Status
- Contributing
Screenshots
View in Alliance Auth
Discord Ping Examples
Pre-Ping
Formup: NOW
Installation
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)
[!NOTE]
You also want to make sure that you have the Discord service installed, configured and activated before installing this app.
Bare Metal Installation
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==3.7.2
Step 2: Update Your AA Settings
Configure your AA settings (local.py
) as follows:
- Add
'fleetpings',
toINSTALLED_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
Continue with the common setup steps below.
Docker Installation
Step 1: Add the App
Add the app to your conf/requirements.txt
:
aa-fleetpings==3.7.2
Step 2: Update Your AA Settings
Configure your AA settings (conf/local.py) as follows:
- Add
'fleetpings',
toINSTALLED_APPS
Step 3: Build Auth and Restart Your Containers
Run the following commands from your AA project directory (the one that contains docker-compose.yml
):
docker compose build --no-cache
docker compose --env-file=.env up -d
Step 4: Finalizing the Installation
Copy static files and run migrations
docker compose exec allianceauth_gunicorn bash
auth collectstatic
auth migrate
Continue with the common setup steps below.
Common Setup Steps
Permission Setup
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.
App Setup
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
Bare Metal Installation
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 aa-fleetpings==3.7.2
python manage.py collectstatic
python manage.py migrate
Finally, restart your AA supervisor services.
Docker Installation
To update your existing installation of AA Fleet Pings, all you need to do is to update the respective line in your conf/requirements.txt
file to the latest version.
aa-fleetpings==3.7.2
Now rebuild your containers:
docker compose build --no-cache
docker compose --env-file=.env up -d
After that, run the following commands to update your database and static files:
docker compose exec allianceauth_gunicorn bash
auth collectstatic
auth migrate
Configuration
The following settings are available in the Django Admin Backend under
/admin/fleetpings/setting/
:
Use Default Fleet Types
Enable or disable the default fleet types (Roaming, Home Defense, StratOP, and CTA) that are shown in the fleet type dropdown in addition to your own.
Default: True
Use Default Ping Targets
Enable or disable the default ping targets (@everyone and @here) that are shown in the ping target dropdown in addition to your own.
Default: 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.
Default: True
Webhook Verification
If you require your pings to be sent to a webhook, that is not a standard discord webhook.
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.
Default: True
Default Embed Color
The default highlight for the embed, that is used when no other highlight color is defined.
Default: #FAA61A
Changelog
See CHANGELOG.md
Translation Status
Do you want to help translate this app into your language or improve the existing translation? - Join our team of translators!
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)
No reviews yet...
Python Requirements
- allianceauth-app-utils>=1.13
- allianceauth<5,>=4.6
- dhooks-lite>=0.6.1
- aa-srp>=1.21; extra == "tests-allianceauth-latest"
- aa-timezones; extra == "tests-allianceauth-latest"
- coverage; extra == "tests-allianceauth-latest"
- django-eveuniverse; extra == "tests-allianceauth-latest"
- django-webtest; extra == "tests-allianceauth-latest"
- faker; extra == "tests-allianceauth-latest"
- fittings; extra == "tests-allianceauth-latest"
Required Python packages to be installed and other Python requirement.
App Dependencies
Required apps:
Used by apps:
-
Dependencies to other apps registered in this app directory.
Classifiers
- Environment :: Web Environment
- Framework :: Django
- Framework :: Django :: 4.2
- Intended Audience :: Developers
- License :: OSI Approved :: GNU General Public License v3 (GPLv3)
- Operating System :: OS Independent
- Programming Language :: Python
- Programming Language :: Python :: 3 :: Only
- Programming Language :: Python :: 3.10
- Programming Language :: Python :: 3.11
- Programming Language :: Python :: 3.12
- Programming Language :: Python :: 3.13
- Topic :: Internet :: WWW/HTTP
- Topic :: Internet :: WWW/HTTP :: Dynamic Content
Version
3.7.2
License
GPLv3
Homepage
https://github.com/ppfeufer/aa-fleetpings
PyPI
https://pypi.org/project/aa-fleetpings/
Last updated
6 hours ago
First published
4 years, 10 months ago
Category
Plugin Apps
Rating
-Authors
Rounon Dax
Maintainers
Rounon Dax
Please login to see more options.