From 9767ce79d84586441ba952d01ed8559d0fa5b77b Mon Sep 17 00:00:00 2001 From: Joel Falknau Date: Tue, 3 Sep 2024 12:26:31 +1000 Subject: [PATCH] cleanup some local.py references --- docs/development/dev_setup/aa-dev-setup-wsl-vsc-v2.md | 2 +- docs/features/services/mumble-docker.md | 2 +- docs/features/services/openfire-docker.md | 2 +- docs/features/services/openfire.md | 4 ++-- docs/features/services/phpbb3.md | 2 +- docs/features/services/smf.md | 2 +- docs/features/services/teamspeak3-docker.md | 6 +++--- docs/features/services/teamspeak3.md | 4 ++-- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/development/dev_setup/aa-dev-setup-wsl-vsc-v2.md b/docs/development/dev_setup/aa-dev-setup-wsl-vsc-v2.md index 9d828abb..64a68a5d 100644 --- a/docs/development/dev_setup/aa-dev-setup-wsl-vsc-v2.md +++ b/docs/development/dev_setup/aa-dev-setup-wsl-vsc-v2.md @@ -337,7 +337,7 @@ To deactivate, click on the debug icon to switch to the debug view. Then uncheck ### AA debug config -In VSC, click on Debug / Add Configuration and choose "Django". Should Django not appear as an option, make sure to first open a Django file (e.g., the local.py settings) to help VSC detect that you are using Django. +In VSC, click on Debug / Add Configuration and choose "Django". Should Django not appear as an option, make sure to first open a Django file (e.g., the `local.py` settings) to help VSC detect that you are using Django. The result should look something like this: diff --git a/docs/features/services/mumble-docker.md b/docs/features/services/mumble-docker.md index 09df8458..974a3d6b 100644 --- a/docs/features/services/mumble-docker.md +++ b/docs/features/services/mumble-docker.md @@ -8,7 +8,7 @@ Mumble is a free voice chat server. While not as flashy as TeamSpeak, it has all In your auth project's settings file (`aa-docker/conf/local.py`), do the following: -- Add `'allianceauth.services.modules.mumble',` to your `INSTALLED_APPS` list +- Add `'allianceauth.services.modules.mumble',` to `INSTALLED_APPS` in your `local.py` - Append the following to your auth project's settings file: ```python diff --git a/docs/features/services/openfire-docker.md b/docs/features/services/openfire-docker.md index e2947f24..cc994f26 100644 --- a/docs/features/services/openfire-docker.md +++ b/docs/features/services/openfire-docker.md @@ -8,7 +8,7 @@ Openfire is a Jabber (XMPP) server. In your auth project's settings file (`aa-docker/conf/local.py`), do the following: -- Add `'allianceauth.services.modules.openfire',` to your `INSTALLED_APPS` list +- Add `'allianceauth.services.modules.openfire',` to `INSTALLED_APPS` in your `local.py` - Append the following to your auth project's settings file: ```python diff --git a/docs/features/services/openfire.md b/docs/features/services/openfire.md index c9cd5b84..3897efa0 100644 --- a/docs/features/services/openfire.md +++ b/docs/features/services/openfire.md @@ -4,7 +4,7 @@ Openfire is a Jabber (XMPP) server. ## Prepare Your Settings -- Add `'allianceauth.services.modules.openfire',` to your `INSTALLED_APPS` list +- Add `'allianceauth.services.modules.openfire',` to `INSTALLED_APPS` in your `local.py` - Append the following to your auth project's settings file: ```python @@ -108,7 +108,7 @@ exit; The remainder of the setup occurs through Openfire’s web interface. Navigate to , or if you’re behind CloudFlare, go straight to your server’s IP:9090. -Select your language. I sure hope it’s English if you’re reading this guide. +Select your language. Under Server Settings, set the Domain to `example.com` replacing it with your actual domain. Don’t touch the rest. diff --git a/docs/features/services/phpbb3.md b/docs/features/services/phpbb3.md index dadd5eb0..08749788 100644 --- a/docs/features/services/phpbb3.md +++ b/docs/features/services/phpbb3.md @@ -12,7 +12,7 @@ phpBB3 requires PHP installed in your web server. Apache has `mod_php`, NGINX re In your auth project's settings file, do the following: -- Add `'allianceauth.services.modules.phpbb3',` to your `INSTALLED_APPS` list +- Add `'allianceauth.services.modules.phpbb3',` to `INSTALLED_APPS` in your `local.py` - Append the following to the bottom of the settings file: ```python diff --git a/docs/features/services/smf.md b/docs/features/services/smf.md index 3a39334e..378832f9 100644 --- a/docs/features/services/smf.md +++ b/docs/features/services/smf.md @@ -12,7 +12,7 @@ SMF requires PHP installed in your web server. Apache has `mod_php`, NGINX requi In your auth project's settings file, do the following: -- Add `'allianceauth.services.modules.smf',` to your `INSTALLED_APPS` list +- Add `'allianceauth.services.modules.smf',` to `INSTALLED_APPS` in your `local.py` - Append the following to the bottom of the settings file: ```python diff --git a/docs/features/services/teamspeak3-docker.md b/docs/features/services/teamspeak3-docker.md index 81c2f24d..909da783 100644 --- a/docs/features/services/teamspeak3-docker.md +++ b/docs/features/services/teamspeak3-docker.md @@ -14,7 +14,7 @@ Sticking with TS3? Alright, I tried. In your auth project's settings file (`aa-docker/conf/local.py`), do the following: -- Add `'allianceauth.services.modules.teamspeak',` to your `INSTALLED_APPS` list +- Add `'allianceauth.services.modules.teamspeak',` to `INSTALLED_APPS` in your `local.py` - Append the following to your auth project's settings file: ```python @@ -32,7 +32,7 @@ CELERYBEAT_SCHEDULE['run_ts3_group_update'] = { } ``` -Add the following lines to your `.env` file +- Add the following lines to your `.env` file ```env # Temspeak @@ -152,7 +152,7 @@ If you have SSH access to the server hosting it, you need to locate the teamspea ### `520 invalid loginname or password` -The serverquery account login specified in local.py is incorrect. Please verify `TEAMSPEAK3_SERVERQUERY_USER` and `TEAMSPEAK3_SERVERQUERY_PASSWORD`. The [installation section](#update-settings) describes where to get them. +The serverquery account login specified in `local.py` is incorrect. Please verify `TEAMSPEAK3_SERVERQUERY_USER` and `TEAMSPEAK3_SERVERQUERY_PASSWORD`. The [installation section](#update-settings) describes where to get them. ### `2568 insufficient client permissions` diff --git a/docs/features/services/teamspeak3.md b/docs/features/services/teamspeak3.md index 8f2baee0..4c58ac21 100644 --- a/docs/features/services/teamspeak3.md +++ b/docs/features/services/teamspeak3.md @@ -14,7 +14,7 @@ Sticking with TS3? Alright, I tried. In your auth project's settings file, do the following: -- Add `'allianceauth.services.modules.teamspeak3',` to your `INSTALLED_APPS` list +- Add `'allianceauth.services.modules.teamspeak3',` to `INSTALLED_APPS` in your `local.py` - Append the following to the bottom of the settings file: ```python @@ -170,7 +170,7 @@ If you have SSH access to the server hosting it, you need to locate the teamspea ### `520 invalid loginname or password` -The serverquery account login specified in local.py is incorrect. Please verify `TEAMSPEAK3_SERVERQUERY_USER` and `TEAMSPEAK3_SERVERQUERY_PASSWORD`. The [installation section](#update-settings) describes where to get them. +The serverquery account login specified in `local.py` is incorrect. Please verify `TEAMSPEAK3_SERVERQUERY_USER` and `TEAMSPEAK3_SERVERQUERY_PASSWORD`. The [installation section](#update-settings) describes where to get them. ### `2568 insufficient client permissions`