aa-discordnotify 0.1.0b3

Forward Alliance Auth notifications to users on Discord

Discord Notify

Forward Alliance Auth notifications to users on Discord

Contents

• Overview
• Installation
• Settings
• Change Log

Overview

This app automatically forwards Alliance Auth notifications to users on Discord.

Features

• Aut notifications appear as DM on Discord
• Notifications are colored according to level (e.g. INFO = blue)
• Option to forward superuser's notifications only

Example

Installation

Preconditions

1. Discord Notify 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)

2. Discord Notify needs Discord Proxy to function. Please make sure the server is up and running on your system, before continuing.

3. Please also make sure you have the Discord service enabled in Alliance Auth.

Step 1 - Install app

Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:

pip install aa-discordnotify

Step 2a - Configure Auth settings

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

• Add "discordnotify" to INSTALLED_APPS
• Optional: Add additional settings if you want to change any defaults. See Settings for the full list.

Step 3 - Finalize App installation

Restart your supervisor services for Auth (no migration required).

Step 4 - Send test notification

To test that your installation was successful you can create a test notification to yourself by navigating to the relative route /discordnotify/test/ in your browser. The absolute URL depends on your Auth site. Example: For an Auth site with the URL https://auth.example.com the test URL would be: https://auth.example.com/discordnotify/test/.

When everything was setup correctly, you will receive a test notification on Discord.

Congratulations you are now ready to use Discord Notify!

Settings

Here is a list of available settings for this app. They can be configured by adding them to your AA settings file (local.py).

Note that all settings are optional and the app will use the documented default settings if they are not used.

Name	Description	Default
DISCORDNOTIFY_DISCORDPROXY_PORT	Port used to communicate with Discord Proxy.	50051
DISCORDNOTIFY_SUPERUSER_ONLY	When set to True, only superusers will be get their notifications forwarded.	False