Skip to main content

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

Project description

AA Discord Announcements

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

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==2.5.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)

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_discord_announcements-2.5.1.tar.gz (71.4 kB view details)

Uploaded Source

Built Distribution

aa_discord_announcements-2.5.1-py3-none-any.whl (134.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for aa_discord_announcements-2.5.1.tar.gz
Algorithm Hash digest
SHA256 76792c5ce33850e9565fe3529739bda6cad5eaa1368019dd6c6293a7b256f22b
MD5 5032dd8fe087e34d4632b21381831d86
BLAKE2b-256 6b10488dd7f1ffcb1bedb9fc15fd65298e7c9f5bdb2255e6a48ce5edebb1ed4d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aa_discord_announcements-2.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1b45605fc42e11b9f003b593eb885786748e9bf1a153b52842617ccaebd6e4ef
MD5 da52ae4cf94ba57a5f3a11d3315dbc9a
BLAKE2b-256 8f5acc0ccc2b18c0e7b396155f4d45bf958ced529cc2ffd88a7bf30fb72142dc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page