Skip to main content

AA Discord Announcements

Version License Python Django pre-commit pre-commit.ci status Code Style: black Checks codecov Translation status Contributor Covenant Discord Alliance Auth Compatibility

ko-fi

Discord Announcements via Alliance Auth

Write announcements and manage who can write announcements on your corporation or alliance Discord through Alliance Auth.



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-discord-announcements

Step 2: Update Your AA Settings

Configure your AA settings (local.py) as follows:

  • Add "aa_discord_announcements", 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

Docker Installation

Step 1: Add the App

Add the app to your conf/requirements.txt

aa-discord-announcements==3.1.1

Step 2: Update Your AA Settings

Configure your AA settings (conf/local.py) as follows:

  • Add "aa_discord_announcements", to INSTALLED_APPS

Step 3: Build Auth and Restart Your Containers

docker compose build
docker compose --env-file=.env up -d

Step 4: Run Migrations and Collect Static Files

docker compose exec allianceauth_gunicorn bash
auth collectstatic
auth migrate

Common Installation Steps

Setting up Permission

Now you can set up permissions in Alliance Auth for your users. Add aa_discord_announcements | general | Can access this app to the states and/or groups you would like to have access.

Setting up the App

In your admin backend you'll find a new section called Discord Announcements. This is where you set all your stuff up, like the webhooks you want to ping and who can ping them. It's pretty straight forward, so you shouldn't have any issues. Go nuts!

Changelog

See CHANGELOG.md

Translation Status

Translation status

Do you want to help translate this app into your language or improve the existing translation? - Join our team of translators!

Contributing

Do 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)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aa_discord_announcements-3.1.1.tar.gz (73.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aa_discord_announcements-3.1.1-py3-none-any.whl (138.0 kB view details)

Uploaded Python 3

File details

Details for the file aa_discord_announcements-3.1.1.tar.gz.

File metadata

  • Download URL: aa_discord_announcements-3.1.1.tar.gz
  • Upload date:
  • Size: 73.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aa_discord_announcements-3.1.1.tar.gz
Algorithm Hash digest
SHA256 57ef0694fdf731f56424a7fbd84f179e123080ca435d7f5c7bf0729a0c33cc3e
MD5 da7f2d5564d84c6a5b70214f2a8999ed
BLAKE2b-256 ea5f117f3bfa706888adb3a98d05b6b19684be7f2f5d7fed864e3bfac8c0fb30

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_discord_announcements-3.1.1.tar.gz:

Publisher: release.yml on ppfeufer/aa-discord-announcements

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aa_discord_announcements-3.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aa_discord_announcements-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3ca5e0536a122eba40c9985513f4c268b587c224bacb08376ecc1fbb1d0237b9
MD5 877e2e8a9c42aa7cafb71c66d23aed31
BLAKE2b-256 bd2ef20d621c98b5fbea34b1825f4c98ba9be6ffb416938bdc5b16b25aca429b

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_discord_announcements-3.1.1-py3-none-any.whl:

Publisher: release.yml on ppfeufer/aa-discord-announcements

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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