split maintenance tasks into bare metal / docker

This commit is contained in:
Joel Falknau
2024-09-03 12:24:17 +10:00
parent cbe6c821cc
commit 98efb9f887
12 changed files with 380 additions and 28 deletions

View File

@@ -6,13 +6,13 @@ Discord is a web-based instant messaging client with voice. Kind of like TeamSpe
Discord is very popular amongst ad-hoc small groups and larger organizations seeking a modern technology. Alternative voice communications should be investigated for larger than small-medium groups for more advanced features.
## Setup
## Setup Auth
### Prepare Your Settings File
Make the following changes in your auth project's settings file (`local.py`):
- Add `'allianceauth.services.modules.discord',` to `INSTALLED_APPS`
- Add `'allianceauth.services.modules.discord',` to `INSTALLED_APPS` in your `local.py`
- Append the following to the bottom of the settings file:
```python
@@ -37,6 +37,34 @@ CELERYBEAT_SCHEDULE['discord.update_all_usernames'] = {
You will have to add most of the values for these settings, e.g., your Discord server ID (aka guild ID), later in the setup process.
:::
### Preparing Auth
Before continuing, it is essential to perform Django Maintenance and restart our Web Service and Workers.
::::{tabs}
:::{group-tab} Bare Metal
```shell
python manage.py migrate
python manage.py collectstatic --noinput
supervisorctl restart myauth:
```
:::
:::{group-tab} Containerized
```shell
docker compose --env-file=.env up -d
docker compose exec allianceauth_gunicorn bash
auth migrate
auth collectstatic
```
:::
::::
## Setup Discord
### Creating a Server
Navigate to the [Discord site](https://discord.com/) and register an account, or log in if you have one already.
@@ -67,10 +95,6 @@ Update your auth project's settings file with these pieces of information from t
- From the OAuth2 > General panel, `DISCORD_APP_SECRET` is the Client Secret
- From the Bot panel, `DISCORD_BOT_TOKEN` is the Token
### Preparing Auth
Before continuing, it is essential to run migrations and restart Gunicorn and Celery.
### Adding a Bot to the Server
Once created, navigate to the "Services" page of your Alliance Auth install as the superuser account. At the top there is a big green button labeled "Link Discord Server". Click it, then from the drop-down select the server you created, and then Authorize.