Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2026-02-04 06:06:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

[ADD] Some helpful comments

Browse Source 
Since this is one of the most occurring issues when editing `local.py`
This commit is contained in:
Peter Pfeufer
2025-11-22 22:27:44 +01:00
parent f5ddbb8004
commit 4047159fd1
3 changed files with 5 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
allianceauth/project_template/project_name/settings/local.py
View File

@@ -57,10 +57,10 @@ DATABASES['default'] = {
# CCP's developer portal # CCP's developer portal
# Logging in to auth requires the publicData scope (can be overridden through the # Logging in to auth requires the publicData scope (can be overridden through the
# LOGIN_TOKEN_SCOPES setting). Other apps may require more (see their docs). # LOGIN_TOKEN_SCOPES setting). Other apps may require more (see their docs).
ESI_SSO_CALLBACK_URL = f"{SITE_URL}/sso/callback" # Do NOT change this line!
ESI_SSO_CLIENT_ID = '' ESI_SSO_CLIENT_ID = ''
ESI_SSO_CLIENT_SECRET = '' ESI_SSO_CLIENT_SECRET = ''
ESI_SSO_CALLBACK_URL = f"{SITE_URL}/sso/callback" ESI_USER_CONTACT_EMAIL = '' # A server maintainer that CCP can contact in case of issues.
ESI_USER_CONTACT_EMAIL = '' # A server maintainer that CCP can contact in case of issues.
# By default, emails are validated before new users can log in. # By default, emails are validated before new users can log in.
# It's recommended to use a free service like SparkPost or Elastic Email to send email. # It's recommended to use a free service like SparkPost or Elastic Email to send email.

8
docker/conf/local.py
View File

@@ -17,9 +17,7 @@ DATABASES["default"] = {
"PASSWORD": os.environ.get("AA_DB_PASSWORD"), "PASSWORD": os.environ.get("AA_DB_PASSWORD"),
"HOST": os.environ.get("AA_DB_HOST"), "HOST": os.environ.get("AA_DB_HOST"),
"PORT": os.environ.get("AA_DB_PORT", "3306"), "PORT": os.environ.get("AA_DB_PORT", "3306"),
"OPTIONS": { "OPTIONS": {"charset": os.environ.get("AA_DB_CHARSET", "utf8mb4")},
"charset": os.environ.get("AA_DB_CHARSET", "utf8mb4")
}
} }
# Register an application at https://developers.eveonline.com for Authentication # Register an application at https://developers.eveonline.com for Authentication
@@ -27,10 +25,9 @@ DATABASES["default"] = {
# to https://example.com/sso/callback substituting your domain for example.com # to https://example.com/sso/callback substituting your domain for example.com
# Logging in to auth requires the publicData scope (can be overridden through the # Logging in to auth requires the publicData scope (can be overridden through the
# LOGIN_TOKEN_SCOPES setting). Other apps may require more (see their docs). # LOGIN_TOKEN_SCOPES setting). Other apps may require more (see their docs).
ESI_SSO_CALLBACK_URL = f"{SITE_URL}/sso/callback" # Do NOT change this line!
ESI_SSO_CLIENT_ID = os.environ.get("ESI_SSO_CLIENT_ID") ESI_SSO_CLIENT_ID = os.environ.get("ESI_SSO_CLIENT_ID")
ESI_SSO_CLIENT_SECRET = os.environ.get("ESI_SSO_CLIENT_SECRET") ESI_SSO_CLIENT_SECRET = os.environ.get("ESI_SSO_CLIENT_SECRET")
ESI_SSO_CALLBACK_URL = f"{SITE_URL}/sso/callback"
ESI_USER_CONTACT_EMAIL = os.environ.get( ESI_USER_CONTACT_EMAIL = os.environ.get(
"ESI_USER_CONTACT_EMAIL" "ESI_USER_CONTACT_EMAIL"
) # A server maintainer that CCP can contact in case of issues. ) # A server maintainer that CCP can contact in case of issues.
@@ -70,7 +67,6 @@ INSTALLED_APPS += [
# 'allianceauth.permissions_tool', # 'allianceauth.permissions_tool',
# 'allianceauth.srp', # 'allianceauth.srp',
# 'allianceauth.timerboard', # 'allianceauth.timerboard',
# https://allianceauth.readthedocs.io/en/latest/features/services/index.html # https://allianceauth.readthedocs.io/en/latest/features/services/index.html
# 'allianceauth.services.modules.discord', # 'allianceauth.services.modules.discord',
# 'allianceauth.services.modules.discourse', # 'allianceauth.services.modules.discourse',

2
docs/features/services/discord.md
View File

@@ -20,8 +20,8 @@ Make the following changes in your auth project's settings file (`local.py`):
# Be sure to set the callback URLto https://example.com/discord/callback/ # Be sure to set the callback URLto https://example.com/discord/callback/
# substituting your domain for example.com in Discord's developer portal # substituting your domain for example.com in Discord's developer portal
# (Be sure to add the trailing slash) # (Be sure to add the trailing slash)
DISCORD_CALLBACK_URL = f"{SITE_URL}/discord/callback/" # Do NOT change this line!
DISCORD_GUILD_ID = '' DISCORD_GUILD_ID = ''
DISCORD_CALLBACK_URL = f"{SITE_URL}/discord/callback/"
DISCORD_APP_ID = '' DISCORD_APP_ID = ''
DISCORD_APP_SECRET = '' DISCORD_APP_SECRET = ''
DISCORD_BOT_TOKEN = '' DISCORD_BOT_TOKEN = ''