Merge branch 'custom-css' into 'master'

[ADD] Custom CSS Module

See merge request allianceauth/allianceauth!1643

.gitlab-ci.yml

@@ -25,7 +25,7 @@ before_script:
 pre-commit-check:
   <<: *only-default
   stage: pre-commit
-  image: python:3.11-bullseye
+  image: python:3.11-bookworm
   # variables:
   #   PRE_COMMIT_HOME: ${CI_PROJECT_DIR}/.cache/pre-commit
   # cache:
@@ -53,7 +53,7 @@ secret_detection:
 
 test-3.8-core:
   <<: *only-default
-  image: python:3.8-bullseye
+  image: python:3.8-bookworm
   script:
     - tox -e py38-core
   artifacts:
@@ -65,7 +65,7 @@ test-3.8-core:
 
 test-3.9-core:
   <<: *only-default
-  image: python:3.9-bullseye
+  image: python:3.9-bookworm
   script:
     - tox -e py39-core
   artifacts:
@@ -77,7 +77,7 @@ test-3.9-core:
 
 test-3.10-core:
   <<: *only-default
-  image: python:3.10-bullseye
+  image: python:3.10-bookworm
   script:
     - tox -e py310-core
   artifacts:
@@ -89,7 +89,7 @@ test-3.10-core:
 
 test-3.11-core:
   <<: *only-default
-  image: python:3.11-bullseye
+  image: python:3.11-bookworm
   script:
     - tox -e py311-core
   artifacts:
@@ -101,7 +101,7 @@ test-3.11-core:
 
 test-3.12-core:
   <<: *only-default
-  image: python:3.12-rc-bullseye
+  image: python:3.12-bookworm
   script:
     - tox -e py312-core
   artifacts:
@@ -113,7 +113,7 @@ test-3.12-core:
 
 test-3.8-all:
   <<: *only-default
-  image: python:3.8-bullseye
+  image: python:3.8-bookworm
   script:
     - tox -e py38-all
   artifacts:
@@ -125,7 +125,7 @@ test-3.8-all:
 
 test-3.9-all:
   <<: *only-default
-  image: python:3.9-bullseye
+  image: python:3.9-bookworm
   script:
     - tox -e py39-all
   artifacts:
@@ -137,7 +137,7 @@ test-3.9-all:
 
 test-3.10-all:
   <<: *only-default
-  image: python:3.10-bullseye
+  image: python:3.10-bookworm
   script:
     - tox -e py310-all
   artifacts:
@@ -149,7 +149,7 @@ test-3.10-all:
 
 test-3.11-all:
   <<: *only-default
-  image: python:3.11-bullseye
+  image: python:3.11-bookworm
   script:
     - tox -e py311-all
   artifacts:
@@ -162,7 +162,7 @@ test-3.11-all:
 
 test-3.12-all:
   <<: *only-default
-  image: python:3.12-rc-bullseye
+  image: python:3.12-bookworm
   script:
     - tox -e py312-all
   artifacts:
@@ -174,7 +174,7 @@ test-3.12-all:
 
 build-test:
   stage: test
-  image: python:3.11-bullseye
+  image: python:3.11-bookworm
 
   before_script:
     - python -m pip install --upgrade pip
@@ -193,13 +193,13 @@ build-test:
 
 test-docs:
   <<: *only-default
-  image: python:3.11-bullseye
+  image: python:3.11-bookworm
   script:
     - tox -e docs
 
 deploy_production:
   stage: deploy
-  image: python:3.11-bullseye
+  image: python:3.11-bookworm
 
   before_script:
     - python -m pip install --upgrade pip

.pre-commit-config.yaml

@@ -74,10 +74,15 @@ repos:
             \.mo|
             swagger\.json
           )
-
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.41.0
+    hooks:
+      - id: markdownlint
+        args:
+          - --disable=MD013
   # Infrastructure
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: 2.0.3
+    rev: 2.1.3
     hooks:
       - id: pyproject-fmt
         name: pyproject.toml formatter
@@ -87,7 +92,7 @@ repos:
         additional_dependencies:
           - tox==4.15.0 # https://github.com/tox-dev/tox/releases/latest
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.17
+    rev: v0.18
     hooks:
       - id: validate-pyproject
         name: Validate pyproject.toml

allianceauth/__init__.py

@@ -5,7 +5,7 @@ manage online service access.
 # This will make sure the app is always imported when
 # Django starts so that shared_task will use this app.
 
-__version__ = '4.0.2'
+__version__ = '4.2.2'
 __title__ = 'Alliance Auth'
 __url__ = 'https://gitlab.com/allianceauth/allianceauth'
 NAME = f'{__title__} v{__version__}'

allianceauth/analytics/tasks.py

@@ -101,11 +101,38 @@ def analytics_daily_stats():
                     event_type='Stats')
 
     for appconfig in apps.get_app_configs():
-        analytics_event(namespace='allianceauth.analytics',
-                        task='send_extension_stats',
-                        label=appconfig.label,
-                        value=1,
-                        event_type='Stats')
+        if appconfig.label in [
+            "django_celery_beat",
+            "bootstrapform",
+            "messages",
+            "sessions",
+            "auth",
+            "staticfiles",
+            "users",
+            "addons",
+            "admin",
+            "humanize",
+            "contenttypes",
+            "sortedm2m",
+            "django_bootstrap5",
+            "tokens",
+            "authentication",
+            "services",
+            "framework",
+            "notifications"
+            "eveonline",
+            "navhelper",
+            "analytics",
+            "menu",
+            "theme"
+        ]:
+            pass
+        else:
+            analytics_event(namespace='allianceauth.analytics',
+                            task='send_extension_stats',
+                            label=appconfig.label,
+                            value=1,
+                            event_type='Stats')
 
 
 @shared_task()

allianceauth/apps.py

@@ -5,26 +5,5 @@ from django.core.checks import Warning, Error, register
 class AllianceAuthConfig(AppConfig):
     name = 'allianceauth'
 
-
-@register()
-def check_settings(app_configs, **kwargs):
-    from django.conf import settings
-
-    errors = []
-    if hasattr(settings, "SITE_URL"):
-        if settings.SITE_URL[-1] == "/":
-            errors.append(Warning(
-                "'SITE_URL' Has a trailing slash. This may lead to incorrect links being generated by Auth."))
-    else:
-        errors.append(Error(
-            "No 'SITE_URL' found is settings. This may lead to incorrect links being generated by Auth or Errors in 3rd party modules."))
-    if hasattr(settings, "CSRF_TRUSTED_ORIGINS"):
-        if hasattr(settings, "SITE_URL"):
-            if settings.SITE_URL not in settings.CSRF_TRUSTED_ORIGINS:
-                errors.append(Warning(
-                    "'SITE_URL' not found in 'CSRF_TRUSTED_ORIGINS'. Auth may not load pages correctly until this is rectified."))
-    else:
-        errors.append(Error(
-            "No 'CSRF_TRUSTED_ORIGINS' found is settings, Auth may not load pages correctly until this is rectified"))
-
-    return errors
+    def ready(self) -> None:
+        import allianceauth.checks # noqa

allianceauth/authentication/templates/authentication/dashboard.html

@@ -7,7 +7,7 @@
     {% translate "Dashboard" %}
 {% endblock %}
 {% block content %}
-    <div class="d-flex justify-content-around align-self-center flex-wrap">
+    <div class="row">
         {% for dash in views %}
             {{ dash | safe }}
         {% endfor %}

allianceauth/authentication/templates/authentication/dashboard_characters.html

@@ -1,13 +1,11 @@
 {% load i18n %}
-<div id="aa-dashboard-panel-characters" class="col-12 col-xl-8 align-self-stretch p-2 ps-0 pe-0 ps-xl-0 pe-xl-2">
-    <div class="card">
+<div id="aa-dashboard-panel-characters" class="col-12 col-xl-8 mb-3">
+    <div class="card h-100">
         <div class="card-body">
-            <div class="d-flex align-items-center">
-                <h4 class="ms-auto me-auto">
-                    {% translate "Characters" %}
-                </h4>
-            </div>
-            <div class="card-body">
+            {% translate "Characters" as widget_title %}
+            {% include "framework/dashboard/widget-title.html" with title=widget_title %}
+
+            <div>
                 <div style="height: 300px; overflow-y:auto;">
                     <div class="d-flex">
                         <a href="{% url 'authentication:add_character' %}" class="btn btn-primary flex-fill m-1" title="{% translate 'Add Character' %}">

allianceauth/authentication/templates/authentication/dashboard_groups.html

@@ -1,9 +1,11 @@
 {% load i18n %}
-<div id="aa-dashboard-panel-membership" class="col-12 col-xl-4 align-self-stretch py-2 ps-xl-2">
+<div id="aa-dashboard-panel-membership" class="col-12 col-xl-4 mb-3">
     <div class="card h-100">
         <div class="card-body">
-            <h4 class="card-title text-center">{% translate "Membership" %}</h4>
-            <div class="card-body">
+            {% translate "Membership" as widget_title %}
+            {% include "framework/dashboard/widget-title.html" with title=widget_title %}
+
+            <div>
                 <div style="height: 300px; overflow-y:auto;">
                     <h5 class="text-center">{% translate "State:" %} {{ request.user.profile.state }}</h5>
                     <table class="table">

allianceauth/checks.py

@@ -0,0 +1,187 @@
+from typing import List
+from django import db
+from django.core.checks import CheckMessage, Error, register, Warning
+from allianceauth.utils.cache import get_redis_client
+from django.utils import timezone
+from packaging.version import InvalidVersion, Version as Pep440Version
+from celery import current_app
+from django.conf import settings
+from sqlite3.dbapi2 import sqlite_version_info
+
+"""
+A = System Packages
+B = Configuration
+"""
+
+
+@register()
+def django_settings(app_configs, **kwargs) -> List[CheckMessage]:
+    errors: List[CheckMessage] = []
+    if hasattr(settings, "SITE_URL"):
+        if settings.SITE_URL[-1] == "/":
+            errors.append(Warning("'SITE_URL' Has a trailing slash. This may lead to incorrect links being generated by Auth.", hint="", id="allianceauth.checks.B005"))
+    else:
+        errors.append(Error("No 'SITE_URL' found is settings. This may lead to incorrect links being generated by Auth or Errors in 3rd party modules.", hint="", id="allianceauth.checks.B006"))
+
+    if hasattr(settings, "CSRF_TRUSTED_ORIGINS") and hasattr(settings, "SITE_URL"):
+        if settings.SITE_URL not in settings.CSRF_TRUSTED_ORIGINS:
+            errors.append(Warning("'SITE_URL' not found in 'CSRF_TRUSTED_ORIGINS'. Auth may not load pages correctly until this is rectified.", hint="", id="allianceauth.checks.B007"))
+    else:
+        errors.append(Error("No 'CSRF_TRUSTED_ORIGINS' found is settings, Auth may not load pages correctly until this is rectified", hint="", id="allianceauth.checks.B008"))
+
+    return errors
+
+
+@register()
+def system_package_redis(app_configs, **kwargs) -> List[CheckMessage]:
+    errors: List[CheckMessage] = []
+    try:
+        redis_version = Pep440Version(get_redis_client().info()['redis_version'])
+    except InvalidVersion:
+        errors.append(Warning("Unable to confirm Redis Version"))
+        return errors
+
+    if redis_version.major == 7 and redis_version.minor == 2 and timezone.now() > timezone.datetime(year=2025, month=8, day=31, tzinfo=timezone.utc):
+        errors.append(Error(f"Redis {redis_version.public} in Security Support only, Updating Suggested", hint="https://allianceauth.readthedocs.io/en/latest/installation/allianceauth.html#redis-and-other-tools", id="allianceauth.checks.A001"))
+    elif redis_version.major == 7 and redis_version.minor == 0:
+        errors.append(Warning(f"Redis {redis_version.public} in Security Support only, Updating Suggested", hint="https://allianceauth.readthedocs.io/en/latest/installation/allianceauth.html#redis-and-other-tools", id="allianceauth.checks.A002"))
+    elif redis_version.major == 6 and redis_version.minor == 2:
+        errors.append(Warning(f"Redis {redis_version.public} in Security Support only, Updating Suggested", hint="https://allianceauth.readthedocs.io/en/latest/installation/allianceauth.html#redis-and-other-tools", id="allianceauth.checks.A018"))
+    elif redis_version.major in [6, 5]:
+        errors.append(Error(f"Redis {redis_version.public} EOL", hint="https://allianceauth.readthedocs.io/en/latest/installation/allianceauth.html#redis-and-other-tools", id="allianceauth.checks.A003"))
+
+    return errors
+
+
+@register()
+def system_package_mysql(app_configs, **kwargs) -> List[CheckMessage]:
+    errors: List[CheckMessage] = []
+
+    for connection in db.connections.all():
+        if connection.vendor == "mysql":
+            try:
+                mysql_version = Pep440Version(".".join(str(i) for i in connection.mysql_version))
+            except InvalidVersion:
+                errors.append(Warning("Unable to confirm MySQL Version"))
+                return errors
+
+            # MySQL 8
+            if mysql_version.major == 8 and mysql_version.minor == 4 and timezone.now() > timezone.datetime(year=2032, month=4, day=30, tzinfo=timezone.utc):
+                errors.append(Error(f"MySQL {mysql_version.public} EOL", hint="https://dev.mysql.com/doc/mysql-apt-repo-quick-guide/en/", id="allianceauth.checks.A004"))
+            elif mysql_version.major == 8 and mysql_version.minor == 3:
+                errors.append(Warning(f"MySQL {mysql_version.public} Non LTS", hint="https://dev.mysql.com/doc/mysql-apt-repo-quick-guide/en/", id="allianceauth.checks.A005"))
+            elif mysql_version.major == 8 and mysql_version.minor == 2:
+                errors.append(Warning(f"MySQL {mysql_version.public} Non LTS", hint="https://dev.mysql.com/doc/mysql-apt-repo-quick-guide/en/", id="allianceauth.checks.A006"))
+            elif mysql_version.major == 8 and mysql_version.minor == 1:
+                errors.append(Error(f"MySQL {mysql_version.public} EOL", hint="https://dev.mysql.com/doc/mysql-apt-repo-quick-guide/en/", id="allianceauth.checks.A007"))
+            elif mysql_version.major == 8 and mysql_version.minor == 0 and timezone.now() > timezone.datetime(year=2026, month=4, day=30, tzinfo=timezone.utc):
+                errors.append(Error(f"MySQL {mysql_version.public} EOL", hint="https://dev.mysql.com/doc/mysql-apt-repo-quick-guide/en/", id="allianceauth.checks.A008"))
+            elif mysql_version.major < 8:  # This will also catch Mariadb 5.x
+                errors.append(Error(f"MySQL or MariaDB {mysql_version.public} EOL", hint="https://dev.mysql.com/doc/mysql-apt-repo-quick-guide/en/", id="allianceauth.checks.A009"))
+    return errors
+
+
+@register()
+def system_package_mariadb(app_configs, **kwargs) -> List[CheckMessage]:
+    errors: List[CheckMessage] = []
+
+    for connection in db.connections.all():
+        if connection.vendor == "mysql":  # Still to find a way to determine MySQL vs MariaDB
+            try:
+                mariadb_version = Pep440Version(".".join(str(i) for i in connection.mysql_version))
+            except InvalidVersion:
+                errors.append(Warning("Unable to confirm MariaDB Version"))
+                return errors
+
+            # MariaDB 11
+            if mariadb_version.major == 11 and mariadb_version.minor == 4 and timezone.now() > timezone.datetime(year=2029, month=5, day=19, tzinfo=timezone.utc):
+                errors.append(Error(f"MariaDB {mariadb_version.public} EOL", hint="https://mariadb.org/download/?t=repo-config", id="allianceauth.checks.A010"))
+            elif mariadb_version.major == 11 and mariadb_version.minor == 2:
+                errors.append(Warning(f"MariaDB {mariadb_version.public} Non LTS", hint="https://mariadb.org/download/?t=repo-config", id="allianceauth.checks.A018"))
+                if timezone.now() > timezone.datetime(year=2024, month=11, day=21, tzinfo=timezone.utc):
+                    errors.append(Error(f"MariaDB {mariadb_version.public}  EOL", hint="https://mariadb.org/download/?t=repo-config", id="allianceauth.checks.A011"))
+            elif mariadb_version.major == 11 and mariadb_version.minor == 1:
+                errors.append(Warning(f"MariaDB {mariadb_version.public} Non LTS", hint="https://mariadb.org/download/?t=repo-config", id="allianceauth.checks.A019"))
+                if timezone.now() > timezone.datetime(year=2024, month=8, day=21, tzinfo=timezone.utc):
+                    errors.append(Error(f"MariaDB {mariadb_version.public} EOL", hint="https://mariadb.org/download/?t=repo-config", id="allianceauth.checks.A012"))
+            elif mariadb_version.major == 11 and mariadb_version.minor in [0, 3]:  # Demote versions down here once EOL
+                errors.append(Error(f"MariaDB {mariadb_version.public} EOL", hint="https://mariadb.org/download/?t=repo-config.", id="allianceauth.checks.A013"))
+
+            # MariaDB 10
+            elif mariadb_version.major == 10 and mariadb_version.minor == 11 and timezone.now() > timezone.datetime(year=2028, month=2, day=10, tzinfo=timezone.utc):
+                errors.append(Error(f"MariaDB {mariadb_version.public} EOL", hint="https://mariadb.org/download/?t=repo-config.", id="allianceauth.checks.A014"))
+            elif mariadb_version.major == 10 and mariadb_version.minor == 6 and timezone.now() > timezone.datetime(year=2026, month=7, day=6, tzinfo=timezone.utc):
+                errors.append(Error(f"MariaDB {mariadb_version.public} EOL", hint="https://mariadb.org/download/?t=repo-config", id="allianceauth.checks.A0015"))
+            elif mariadb_version.major == 10 and mariadb_version.minor == 5 and timezone.now() > timezone.datetime(year=2025, month=6, day=24, tzinfo=timezone.utc):
+                errors.append(Error(f"MariaDB {mariadb_version.public} EOL", hint="https://mariadb.org/download/?t=repo-config", id="allianceauth.checks.A016"))
+            elif mariadb_version.major == 10 and mariadb_version.minor in [0, 1, 2, 3, 4, 7, 9, 10]:  # Demote versions down here once EOL
+                errors.append(Error(f"MariaDB {mariadb_version.public} EOL", hint="https://mariadb.org/download/?t=repo-config", id="allianceauth.checks.A017"))
+
+    return errors
+
+
+@register()
+def system_package_sqlite(app_configs, **kwargs) -> List[CheckMessage]:
+    errors: List[CheckMessage] = []
+    for connection in db.connections.all():
+        if connection.vendor == "sqlite":
+            try:
+                sqlite_version = Pep440Version(".".join(str(i) for i in sqlite_version_info))
+            except InvalidVersion:
+                errors.append(Warning("Unable to confirm SQLite Version"))
+                return errors
+            if sqlite_version.major == 3 and sqlite_version.minor < 27:
+                errors.append(Error(f"SQLite {sqlite_version.public} Unsupported by Django", hint="https://pkgs.org/download/sqlite3", id="allianceauth.checks.A020"))
+    return errors
+
+
+@register()
+def sql_settings(app_configs, **kwargs) -> List[CheckMessage]:
+    errors: List[CheckMessage] = []
+    for connection in db.connections.all():
+        if connection.vendor == "mysql":
+            try:
+                if connection.settings_dict["OPTIONS"]["charset"] != "utf8mb4":
+                    errors.append(Error(f"SQL Charset is not set to utf8mb4 DB:{connection.alias}", hint="https://gitlab.com/allianceauth/allianceauth/-/commit/89be2456fb2d741b86417e889da9b6129525bec8", id="allianceauth.checks.B001"))
+            except KeyError:
+                errors.append(Error(f"SQL Charset is not set to utf8mb4 DB:{connection.alias}", hint="https://gitlab.com/allianceauth/allianceauth/-/commit/89be2456fb2d741b86417e889da9b6129525bec8", id="allianceauth.checks.B001"))
+
+            # This hasn't actually been set on AA yet
+            # try:
+            #     if connection.settings_dict["OPTIONS"]["collation"] != "utf8mb4_unicode_ci":
+            #         errors.append(Error(f"SQL Collation is not set to utf8mb4_unicode_ci DB:{connection.alias}", hint="https://gitlab.com/allianceauth/allianceauth/-/commit/89be2456fb2d741b86417e889da9b6129525bec8", id="allianceauth.checks.B001"))
+            # except KeyError:
+            #     errors.append(Error(f"SQL Collation is not set to utf8mb4_unicode_ci DB:{connection.alias}", hint="https://gitlab.com/allianceauth/allianceauth/-/commit/89be2456fb2d741b86417e889da9b6129525bec8", id="allianceauth.checks.B001"))
+
+        # if connection.vendor == "sqlite":
+
+    return errors
+
+
+@register()
+def celery_settings(app_configs, **kwargs) -> List[CheckMessage]:
+    errors: List[CheckMessage] = []
+
+    try:
+        if current_app.conf.broker_transport_options != {'priority_steps': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], 'queue_order_strategy': 'priority'}:
+            errors.append(Error("Celery Priorities are not set correctly", hint="https://gitlab.com/allianceauth/allianceauth/-/commit/8861ec0a61790eca0261f1adc1cc04ca5f243cbc", id="allianceauth.checks.B003"))
+    except KeyError:
+        errors.append(Error("Celery Priorities are not set", hint="https://gitlab.com/allianceauth/allianceauth/-/commit/8861ec0a61790eca0261f1adc1cc04ca5f243cbc", id="allianceauth.checks.B003"))
+
+    try:
+        if current_app.conf.broker_connection_retry_on_startup != True:
+            errors.append(Error("Celery broker_connection_retry_on_startup not set correctly", hint="https://gitlab.com/allianceauth/allianceauth/-/commit/380c41400b535447839e5552df2410af35a75280", id="allianceauth.checks.B004"))
+    except KeyError:
+        errors.append(Error("Celery broker_connection_retry_on_startup not set", hint="https://gitlab.com/allianceauth/allianceauth/-/commit/380c41400b535447839e5552df2410af35a75280", id="allianceauth.checks.B004"))
+
+    return errors
+
+
+# IDEAS
+
+# Any other celery things weve manually changed over the years
+# I'd be happy to add Community App checks, old versions the owners dont want to support etc.
+
+
+# Check Default Collation on DB
+# Check Charset Collation on all tables

allianceauth/custom_css/__init__.py

@@ -0,0 +1,3 @@
+"""
+Initializes the custom_css module.
+"""

allianceauth/custom_css/admin.py

@@ -0,0 +1,25 @@
+"""
+Admin classes for custom_css app
+"""
+
+# Django
+from django.contrib import admin
+
+# Django Solos
+from solo.admin import SingletonModelAdmin
+
+# Alliance Auth Custom CSS
+from allianceauth.custom_css.models import CustomCSS
+from allianceauth.custom_css.forms import CustomCSSAdminForm
+
+
+@admin.register(CustomCSS)
+class CustomCSSAdmin(SingletonModelAdmin):
+    """
+    Custom CSS Admin
+    """
+
+    form = CustomCSSAdminForm
+
+    # Leave this here for when we decide to add syntax highlighting to the CSS editor
+    # change_form_template = 'custom_css/admin/change_form.html'

allianceauth/custom_css/apps.py

@@ -0,0 +1,13 @@
+"""
+Django app configuration for custom_css
+"""
+
+# Django
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class CustomCSSConfig(AppConfig):
+    name = "allianceauth.custom_css"
+    label = "custom_css"
+    verbose_name = _("Custom CSS")

allianceauth/custom_css/forms.py

@@ -0,0 +1,29 @@
+"""
+Forms for custom_css app
+"""
+
+# Alliance Auth Custom CSS
+from allianceauth.custom_css.models import CustomCSS
+from allianceauth.custom_css.widgets import CssEditorWidget
+
+# Django
+from django import forms
+
+
+class CustomCSSAdminForm(forms.ModelForm):
+    """
+    Form for editing custom CSS
+    """
+
+    class Meta:
+        model = CustomCSS
+        fields = ("css",)
+        widgets = {
+            "css": CssEditorWidget(
+                attrs={
+                    "style": "width: 90%; height: 100%;",
+                    "data-editor": "code-highlight",
+                    "data-language": "css",
+                }
+            )
+        }

allianceauth/custom_css/migrations/0001_initial.py

@@ -0,0 +1,42 @@
+# Generated by Django 4.2.15 on 2024-08-14 11:25
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="CustomCSS",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "css",
+                    models.TextField(
+                        blank=True,
+                        help_text="This CSS will be added to the site after the default CSS.",
+                        null=True,
+                        verbose_name="Your custom CSS",
+                    ),
+                ),
+                ("timestamp", models.DateTimeField(auto_now=True)),
+            ],
+            options={
+                "verbose_name": "Custom CSS",
+                "verbose_name_plural": "Custom CSS",
+                "default_permissions": (),
+            },
+        ),
+    ]

allianceauth/custom_css/models.py

@@ -0,0 +1,143 @@
+"""
+Models for the custom_css app
+"""
+
+import os
+import re
+
+# Django Solo
+from solo.models import SingletonModel
+
+# Django
+from django.conf import settings
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+
+class CustomCSS(SingletonModel):
+    """
+    Model for storing custom CSS for the site
+    """
+
+    css = models.TextField(
+        blank=True,
+        null=True,
+        verbose_name=_("Your custom CSS"),
+        help_text=_("This CSS will be added to the site after the default CSS."),
+    )
+    timestamp = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        """
+        Meta for CustomCSS
+        """
+
+        default_permissions = ()
+        verbose_name = _("Custom CSS")
+        verbose_name_plural = _("Custom CSS")
+
+    def __str__(self) -> str:
+        """
+        String representation of CustomCSS
+
+        :return:
+        :rtype:
+        """
+
+        return str(_("Custom CSS"))
+
+    def save(self, *args, **kwargs):
+        """
+        Save method for CustomCSS
+
+        :param args:
+        :type args:
+        :param kwargs:
+        :type kwargs:
+        :return:
+        :rtype:
+        """
+
+        self.pk = 1
+
+        if self.css and len(self.css.replace(" ", "")) > 0:
+            # Write the custom CSS to a file
+            custom_css_file = open(
+                f"{settings.STATIC_ROOT}allianceauth/custom-styles.css", "w+"
+            )
+            custom_css_file.write(self.compress_css())
+            custom_css_file.close()
+        else:
+            # Remove the custom CSS file
+            try:
+                os.remove(f"{settings.STATIC_ROOT}allianceauth/custom-styles.css")
+            except FileNotFoundError:
+                pass
+
+        super().save(*args, **kwargs)
+
+    def compress_css(self) -> str:
+        """
+        Compress CSS
+
+        :return:
+        :rtype:
+        """
+
+        css = self.css
+        new_css = ""
+
+        # Remove comments
+        css = re.sub(pattern=r"\s*/\*\s*\*/", repl="$$HACK1$$", string=css)
+        css = re.sub(pattern=r"/\*[\s\S]*?\*/", repl="", string=css)
+        css = css.replace("$$HACK1$$", "/**/")
+
+        # url() doesn't need quotes
+        css = re.sub(pattern=r'url\((["\'])([^)]*)\1\)', repl=r"url(\2)", string=css)
+
+        # Spaces may be safely collapsed as generated content will collapse them anyway.
+        css = re.sub(pattern=r"\s+", repl=" ", string=css)
+
+        # Shorten collapsable colors: #aabbcc to #abc
+        css = re.sub(
+            pattern=r"#([0-9a-f])\1([0-9a-f])\2([0-9a-f])\3(\s|;)",
+            repl=r"#\1\2\3\4",
+            string=css,
+        )
+
+        # Fragment values can loose zeros
+        css = re.sub(
+            pattern=r":\s*0(\.\d+([cm]m|e[mx]|in|p[ctx]))\s*;", repl=r":\1;", string=css
+        )
+
+        for rule in re.findall(pattern=r"([^{]+){([^}]*)}", string=css):
+            # We don't need spaces around operators
+            selectors = [
+                re.sub(
+                    pattern=r"(?<=[\[\(>+=])\s+|\s+(?=[=~^$*|>+\]\)])",
+                    repl=r"",
+                    string=selector.strip(),
+                )
+                for selector in rule[0].split(",")
+            ]
+
+            # Order is important, but we still want to discard repetitions
+            properties = {}
+            porder = []
+
+            for prop in re.findall(pattern="(.*?):(.*?)(;|$)", string=rule[1]):
+                key = prop[0].strip().lower()
+
+                if key not in porder:
+                    porder.append(key)
+
+                properties[key] = prop[1].strip()
+
+            # output rule if it contains any declarations
+            if properties:
+                new_css += "{}{{{}}}".format(
+                    ",".join(selectors),
+                    "".join([f"{key}:{properties[key]};" for key in porder])[:-1],
+                )
+
+        return new_css

allianceauth/custom_css/templates/custom_css/admin/change_form.html

@@ -0,0 +1,48 @@
+{% extends "admin/change_form.html" %}
+
+{% block field_sets %}
+    {% for fieldset in adminform %}
+        <fieldset class="module aligned {{ fieldset.classes }}">
+            {% if fieldset.name %}<h2>{{ fieldset.name }}</h2>{% endif %}
+
+            {% if fieldset.description %}
+                <div class="description">{{ fieldset.description|safe }}</div>
+            {% endif %}
+
+            {% for line in fieldset %}
+                <div class="form-row{% if line.fields|length == 1 and line.errors %} errors{% endif %}{% if not line.has_visible_field %} hidden{% endif %}{% for field in line %}{% if field.field.name %} field-{{ field.field.name }}{% endif %}{% endfor %}">
+                    {% if line.fields|length == 1 %}{{ line.errors }}{% else %}<div class="flex-container form-multiline">{% endif %}
+
+                    {% for field in line %}
+                        <div>
+                            {% if not line.fields|length == 1 and not field.is_readonly %}{{ field.errors }}{% endif %}
+
+                            <div class="flex-container{% if not line.fields|length == 1 %} fieldBox{% if field.field.name %} field-{{ field.field.name }}{% endif %}{% if not field.is_readonly and field.errors %} errors{% endif %}{% if field.field.is_hidden %} hidden{% endif %}{% elif field.is_checkbox %} checkbox-row{% endif %}">
+                                {% if field.is_checkbox %}
+                                    {{ field.field }}{{ field.label_tag }}
+                                {% else %}
+                                    {{ field.label_tag }}
+                                    {% if field.is_readonly %}
+                                        <div class="readonly">{{ field.contents }}</div>
+                                    {% else %}
+                                        {{ field.field }}
+                                    {% endif %}
+                                {% endif %}
+                            </div>
+
+                            {% if field.field.help_text %}
+                                <div class="help"{% if field.field.id_for_label %} id="{{ field.field.id_for_label }}_helptext"{% endif %}>
+                                    <div>{{ field.field.help_text|safe }}</div>
+                                </div>
+                            {% endif %}
+                        </div>
+                    {% endfor %}
+
+                    {% if not line.fields|length == 1 %}</div>{% endif %}
+                </div>
+            {% endfor %}
+        </fieldset>
+    {% endfor %}
+{% endblock %}
+
+{% block after_field_sets %}{% endblock %}

allianceauth/custom_css/templates/custom_css/bundles/custom-css.html

@@ -0,0 +1,3 @@
+{% load custom_css %}
+
+{% custom_css_static 'allianceauth/custom-styles.css' %}

allianceauth/custom_css/templatetags/__init__.py

@@ -0,0 +1,3 @@
+"""
+Init file for custom_css templatetags
+"""

allianceauth/custom_css/templatetags/custom_css.py

@@ -0,0 +1,48 @@
+"""
+Custom template tags for custom_css app
+"""
+
+# Alliance Auth Custom CSS
+from allianceauth.custom_css.models import CustomCSS
+
+# Django
+from django.conf import settings
+from django.template.defaulttags import register
+from django.templatetags.static import static
+from django.utils.safestring import mark_safe
+
+from pathlib import Path
+
+
+@register.simple_tag
+def custom_css_static(path: str) -> str:
+    """
+    Versioned static URL
+    This is to make sure to break the browser cache on CSS updates.
+
+    Example: /static/allianceauth/custom-styles.css?v=1234567890
+
+    :param path:
+    :type path:
+    :return:
+    :rtype:
+    """
+
+    try:
+        Path(f"{settings.STATIC_ROOT}{path}").resolve(strict=True)
+    except FileNotFoundError:
+        return ""
+    else:
+        try:
+            custom_css = CustomCSS.objects.get(pk=1)
+        except CustomCSS.DoesNotExist:
+            return ""
+        else:
+            custom_css_changed = custom_css.timestamp.timestamp()
+            custom_css_version = (
+                str(custom_css_changed).replace(" ", "").replace(":", "").replace("-", "")
+            )  # remove spaces, colons, and dashes
+            static_url = static(path)
+            versioned_url = static_url + "?v=" + custom_css_version
+
+            return mark_safe(f'<link rel="stylesheet" href="{versioned_url}">')

allianceauth/custom_css/widgets.py

@@ -0,0 +1,38 @@
+"""
+Form widgets for custom_css app
+"""
+
+# Django
+from django import forms
+
+# Alliance Auth
+from allianceauth.custom_css.models import CustomCSS
+
+
+class CssEditorWidget(forms.Textarea):
+    """
+    Widget for editing CSS
+    """
+
+    def __init__(self, attrs=None):
+        default_attrs = {"class": "custom-css-editor"}
+
+        if attrs:
+            default_attrs.update(attrs)
+
+        super().__init__(default_attrs)
+
+    # For when we want to add some sort of syntax highlight to it, which is not that
+    # easy to do on a textarea field though.
+    # `highlight.js` is just used as an example here, and doesn't work on a textarea field.
+    # class Media:
+    #     css = {
+    #         "all": (
+    #             "/static/custom_css/libs/highlight.js/11.10.0/styles/github.min.css",
+    #         )
+    #     }
+    #     js = (
+    #         "/static/custom_css/libs/highlight.js/11.10.0/highlight.min.js",
+    #         "/static/custom_css/libs/highlight.js/11.10.0/languages/css.min.js",
+    #         "/static/custom_css/javascript/custom-css.min.js",
+    #     )

allianceauth/framework/templates/framework/dashboard/widget-title.html

@@ -0,0 +1,8 @@
+{#Usage:#}
+{#    {% include "framework/dashboard/widget-title.html" with title="Foobar" %}#}
+
+<div class="text-center">
+    <h4 class="ms-auto me-auto mb-3">
+        {{ title }}
+    </h4>
+</div>

allianceauth/menu/templates/menu/menu-user.html

@@ -60,15 +60,17 @@
                     <li>
                         <a class="dropdown-item"  href="https://discord.gg/fjnHAmk" title="Alliance Auth Discord"><i class="fa-brands fa-discord fa-fw"></i> Alliance Auth Discord</a>
                     </li>
-                        <li>
-                            <a class="dropdown-item" href="https://gitlab.com/allianceauth/allianceauth" title="Alliance Auth Git"><i class="fa-brands fa-gitlab fa-fw"></i> Alliance Auth Git</a>
-                        </li>
                     <li>
-                        <a class="dropdown-item" href="{% url 'admin:index' %}">
-                            <i class="fa-solid fa-gear fa-fw"></i> {% translate "Admin" %}
-                        </a>
+                        <a class="dropdown-item" href="https://gitlab.com/allianceauth/allianceauth" title="Alliance Auth Git"><i class="fa-brands fa-gitlab fa-fw"></i> Alliance Auth Git</a>
                     </li>
                 {% endif %}
+                {% if user.is_staff %}
+                <li>
+                    <a class="dropdown-item" href="{% url 'admin:index' %}">
+                        <i class="fa-solid fa-gear fa-fw"></i> {% translate "Admin" %}
+                    </a>
+                </li>
+                {% endif %}
                 <li><hr class="dropdown-divider"></li>
                 {% if user.is_authenticated %}
                     <li>

allianceauth/optimer/templates/optimer/dashboard.ops.html

@@ -1,41 +1,40 @@
 {% load i18n %}
 {% load evelinks %}
 
-<div class="col-12 align-self-stretch py-2">
+<div class="col-12 mb-3">
     <div class="card h-100">
         <div class="card-body">
-            <h4 class="card-title text-center">{% translate "Upcoming Fleets" %}</h4>
+            {% translate "Upcoming Fleets" as widget_title %}
+            {% include "framework/dashboard/widget-title.html" with title=widget_title %}
 
-            <div class="card-body">
-                <div>
-                    <table class="table">
-                        <thead>
+            <div>
+                <table class="table">
+                    <thead>
+                        <tr>
+                            <th class="text-center">{% translate "Operation" %}</th>
+                            <th class="text-center">{% translate "Type" %}</th>
+                            <th class="text-center">{% translate "Form Up System" %}</th>
+                            <th class="text-center">{% translate "EVE Time" %}</th>
+                        </tr>
+                    </thead>
+
+                    <tbody>
+                        {% for ops in timers %}
                             <tr>
-                                <th class="text-center">{% translate "Operation" %}</th>
-                                <th class="text-center">{% translate "Type" %}</th>
-                                <th class="text-center">{% translate "Form Up System" %}</th>
-                                <th class="text-center">{% translate "EVE Time" %}</th>
+                                <td class="text-center">
+                                    {{ ops.operation_name }}
+                                </td>
+                                <td class="text-center">
+                                    {{ ops.type }}
+                                </td>
+                                <td class="text-center">
+                                    <a href="{{ ops.system|dotlan_solar_system_url }}">{{ ops.system }}</a>
+                                </td>
+                                <td class="text-center" nowrap>{{ ops.start | date:"Y-m-d H:i" }}</td>
                             </tr>
-                        </thead>
-
-                        <tbody>
-                            {% for ops in timers %}
-                                <tr>
-                                    <td class="text-center">
-                                        {{ ops.operation_name }}
-                                    </td>
-                                    <td class="text-center">
-                                        {{ ops.type }}
-                                    </td>
-                                    <td class="text-center">
-                                        <a href="{{ ops.system|dotlan_solar_system_url }}">{{ ops.system }}</a>
-                                    </td>
-                                    <td class="text-center" nowrap>{{ ops.start | date:"Y-m-d H:i" }}</td>
-                                </tr>
-                            {% endfor %}
-                        </tbody>
-                    </table>
-                </div>
+                        {% endfor %}
+                    </tbody>
+                </table>
             </div>
         </div>
     </div>

allianceauth/project_template/project_name/settings/base.py

@@ -22,6 +22,7 @@ INSTALLED_APPS = [
     'django.contrib.staticfiles',
     'django.contrib.humanize',
     'django_celery_beat',
+    'solo',
     'bootstrapform',
     'django_bootstrap5',  # https://github.com/zostera/django-bootstrap5
     'sortedm2m',
@@ -39,6 +40,7 @@ INSTALLED_APPS = [
     'allianceauth.theme.darkly',
     'allianceauth.theme.flatly',
     'allianceauth.theme.materia',
+    "allianceauth.custom_css",
 ]
 
 SECRET_KEY = "wow I'm a really bad default secret key"

allianceauth/services/modules/mumble/templates/services/mumble/mumble_service_ctrl.html

@@ -7,7 +7,9 @@
 {% endblock %}
 
 {% block url %}
-    <a href="{{ service_url }}">{{ service_url }}</a>
+    {% if username != '' %}
+        <a href="mumble://{{ connect_url }}">{{ service_url }}</a>
+    {% endif %}
 {% endblock %}
 
 {% block user %}

allianceauth/templates/allianceauth/admin-status/esi_check.html

@@ -1,5 +1,5 @@
 {% load i18n %}
-<div id="esi-alert" class="col-12 align-self-stretch py-2 collapse">
+<div id="esi-alert" class="col-12 collapse">
     <div class="alert alert-warning">
         <p class="text-center ">{% translate 'Your Server received an ESI error response code of ' %}<b id="esi-code">?</b></p>
         <hr>
@@ -23,7 +23,7 @@
             console.log("ESI Check: ", JSON.stringify(responseJson, null, 2));
 
             const status = responseJson.status;
-            if (status != 200) {
+            if (status !== 200) {
                 elemCode.textContent = status
                 elemMessage.textContent = responseJson.data.error;
                 new bootstrap.Collapse(elemCard, {

allianceauth/templates/allianceauth/admin-status/overview.html

@@ -2,48 +2,43 @@
 {% load humanize %}
 
 {% if notifications %}
-    <div id="aa-dashboard-panel-admin-notifications" class="col-12 align-self-stretch pb-2">
+    <div id="aa-dashboard-panel-admin-notifications" class="col-12 mb-3">
         <div class="card">
             <div class="card-body">
-                <div class="d-flex align-items-center">
-                    <div class="w-100 align-self-stretch">
-                        <h4 class="ms-auto me-auto text-center">
-                            {% translate "Alliance Auth Notifications" %}
-                        </h4>
+                {% translate "Alliance Auth Notifications" as widget_title %}
+                {% include "framework/dashboard/widget-title.html" with title=widget_title %}
 
-                        <div class="card-body">
-                            <ul class="list-group">
-                                {% for notif in notifications %}
-                                    <li class="list-group-item">
-                                        {% if notif.state == 'opened' %}
-                                            <span class="badge bg-success">{% translate "Open" %}</span>
-                                        {% else %}
-                                            <span class="badge bg-danger">{% translate "Closed" %}</span>
-                                        {% endif %}
-                                        <a href="{{ notif.web_url }}" target="_blank">#{{ notif.iid }} {{ notif.title }}</a>
-                                    </li>
-                                {% empty %}
-                                    <div class="alert alert-primary" role="alert">
-                                        {% translate "No notifications at this time" %}
-                                    </div>
-                                {% endfor %}
-                            </ul>
-
-                            <div class="text-end">
-                                <a href="https://gitlab.com/allianceauth/allianceauth/issues" target="_blank" class="me-1">
-                                    <span class="badge" style="background-color: rgb(230 83 40);">
-                                        <i class="fab fa-gitlab" aria-hidden="true"></i>
-                                        {% translate 'Powered by GitLab' %}
-                                    </span>
-                                </a>
-                                <a href="https://discord.com/invite/fjnHAmk" target="_blank">
-                                    <span class="badge" style="background-color: rgb(110 133 211);">
-                                        <i class="fab fa-discord" aria-hidden="true"></i>
-                                        {% translate 'Support Discord' %}
-                                    </span>
-                                </a>
+                <div>
+                    <ul class="list-group">
+                        {% for notif in notifications %}
+                            <li class="list-group-item">
+                                {% if notif.state == 'opened' %}
+                                    <span class="badge bg-success me-2">{% translate "Open" %}</span>
+                                {% else %}
+                                    <span class="badge bg-danger me-2">{% translate "Closed" %}</span>
+                                {% endif %}
+                                <a href="{{ notif.web_url }}" target="_blank">#{{ notif.iid }} {{ notif.title }}</a>
+                            </li>
+                        {% empty %}
+                            <div class="alert alert-primary" role="alert">
+                                {% translate "No notifications at this time" %}
                             </div>
-                        </div>
+                        {% endfor %}
+                    </ul>
+
+                    <div class="text-end pt-3">
+                        <a href="https://gitlab.com/allianceauth/allianceauth/issues" target="_blank" class="me-1 text-decoration-none">
+                            <span class="badge" style="background-color: rgb(230 83 40);">
+                                <i class="fab fa-gitlab" aria-hidden="true"></i>
+                                {% translate 'Powered by GitLab' %}
+                            </span>
+                        </a>
+                        <a href="https://discord.com/invite/fjnHAmk" target="_blank" class="text-decoration-none">
+                            <span class="badge" style="background-color: rgb(110 133 211);">
+                                <i class="fab fa-discord" aria-hidden="true"></i>
+                                {% translate 'Support Discord' %}
+                            </span>
+                        </a>
                     </div>
                 </div>
             </div>
@@ -51,15 +46,14 @@
     </div>
 {% endif %}
 
-<div class="col-12 align-self-stretch pb-2">
+<div class="col-12 mb-3">
     <div class="card">
-        <div class="card-body d-flex flex-row flex-wrap">
+        <div class="card-body row">
             <div id="aa-dashboard-panel-software-version" class="col-xl-6 col-lg-12 col-md-12 col-sm-12">
-                <h4 class="ms-auto me-auto text-center">
-                    {% translate "Software Version" %}
-                </h4>
+                {% translate "Software Version" as widget_title %}
+                {% include "framework/dashboard/widget-title.html" with title=widget_title %}
 
-                <div class="card-body">
+                <div>
                     <ul class="list-group list-group-horizontal w-100" role="group" aria-label="{% translate 'Software Version' %}">
                         <li class="list-group-item w-100">
                             <div class="btn h-100 w-100 cursor-default">
@@ -98,11 +92,10 @@
             </div>
 
             <div id="aa-dashboard-panel-task-queue" class="col-xl-6 col-lg-12 col-md-12 col-sm-12">
-                <h4 class="ms-auto me-auto text-center">
-                    {% translate "Task Queue" %}
-                </h4>
+                {% translate "Task Queue" as widget_title %}
+                {% include "framework/dashboard/widget-title.html" with title=widget_title %}
 
-                <div class="card-body">
+                <div>
                     <p>
                         {% blocktranslate with total=tasks_total|intcomma latest=earliest_task|timesince|default:"?" %}
                             Status of {{ total }} processed tasks • last {{ latest }}

allianceauth/templates/allianceauth/base-bs5.html

@@ -35,6 +35,8 @@
         </style>
 
         {% block extra_css %}{% endblock extra_css %}
+
+        {% include 'custom_css/bundles/custom-css.html' %}
     </head>
 
     <body>

allianceauth/templates/allianceauth/error.html

@@ -1,31 +1,37 @@
 {% extends "allianceauth/base-bs5.html" %}
 
+{% load theme_tags %}
+
 {% block page_title %}
     {{ error_title }}
 {% endblock page_title %}
 
 {% block content %}
-    <div>
-        {% include "framework/header/page-header.html" with title=error_title %}
+    <div class="d-flex flex-column" style="height: calc(100vh - {% header_padding_size %}); margin-top: -1rem; margin-bottom: -1rem;">
+        <div class="d-flex flex-grow-1 justify-content-center align-items-center">
+            <div>
+                {% include "framework/header/page-header.html" with title=error_title %}
 
-        <div class="text-center">
-            <svg
-                xmlns="http://www.w3.org/2000/svg"
-                width="150"
-                height="150"
-                fill="currentColor"
-                class="bi bi-exclamation-triangle"
-                viewBox="0 0 16 16"
-            >
-                <path
-                    d="M7.938 2.016A.13.13 0 0 1 8.002 2a.13.13 0 0 1 .063.016.146.146 0 0 1 .054.057l6.857 11.667c.036.06.035.124.002.183a.163.163 0 0 1-.054.06.116.116 0 0 1-.066.017H1.146a.115.115 0 0 1-.066-.017.163.163 0 0 1-.054-.06.176.176 0 0 1 .002-.183L7.884 2.073a.147.147 0 0 1 .054-.057zm1.044-.45a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566z"
-                />
-                <path
-                    d="M7.002 12a1 1 0 1 1 2 0 1 1 0 0 1-2 0zM7.1 5.995a.905.905 0 1 1 1.8 0l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995z"
-                />
-            </svg>
+                <div class="text-center">
+                    <svg
+                        xmlns="http://www.w3.org/2000/svg"
+                        width="150"
+                        height="150"
+                        fill="currentColor"
+                        class="bi bi-exclamation-triangle"
+                        viewBox="0 0 16 16"
+                    >
+                        <path
+                            d="M7.938 2.016A.13.13 0 0 1 8.002 2a.13.13 0 0 1 .063.016.146.146 0 0 1 .054.057l6.857 11.667c.036.06.035.124.002.183a.163.163 0 0 1-.054.06.116.116 0 0 1-.066.017H1.146a.115.115 0 0 1-.066-.017.163.163 0 0 1-.054-.06.176.176 0 0 1 .002-.183L7.884 2.073a.147.147 0 0 1 .054-.057zm1.044-.45a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566z"
+                        />
+                        <path
+                            d="M7.002 12a1 1 0 1 1 2 0 1 1 0 0 1-2 0zM7.1 5.995a.905.905 0 1 1 1.8 0l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995z"
+                        />
+                    </svg>
+                </div>
+
+                <p class="text-center">{{ error_message }}</p>
+            </div>
         </div>
-
-        <p class="text-center">{{ error_message }}</p>
     </div>
 {% endblock content %}

allianceauth/theme/bootstrap/auth_hooks.py

@@ -27,6 +27,7 @@ class BootstrapThemeHook(ThemeHook):
             self,
             "Bootstrap",
             "Powerful, extensible, and feature-packed frontend toolkit.",
+            html_tags={"data-theme": "bootstrap"},
             css=CSS_STATICS,
             js=JS_STATICS,
             header_padding="3.5em"
@@ -44,9 +45,9 @@ class BootstrapDarkThemeHook(ThemeHook):
             self,
             "Bootstrap Dark",
             "Powerful, extensible, and feature-packed frontend toolkit.",
+            html_tags={"data-theme": "bootstrap-dark"},
             css=CSS_STATICS,
             js=JS_STATICS,
-            html_tags="data-bs-theme=dark",
             header_padding="3.5em"
         )
 

allianceauth/theme/darkly/auth_hooks.py

@@ -13,6 +13,7 @@ class DarklyThemeHook(ThemeHook):
             self,
             "Darkly",
             "Flatly in night mode!",
+            html_tags={"data-theme": "darkly"},
             css=[{
                 "url": "https://cdnjs.cloudflare.com/ajax/libs/bootswatch/5.3.3/darkly/bootstrap.min.css",
                 "integrity": "sha512-HDszXqSUU0om4Yj5dZOUNmtwXGWDa5ppESlX98yzbBS+z+3HQ8a/7kcdI1dv+jKq+1V5b01eYurE7+yFjw6Rdg=="

allianceauth/theme/flatly/auth_hooks.py

@@ -13,6 +13,7 @@ class FlatlyThemeHook(ThemeHook):
             self,
             "Flatly",
             "Flat and modern!",
+            html_tags={"data-theme": "flatly"},
             css=[{
                 "url": "https://cdnjs.cloudflare.com/ajax/libs/bootswatch/5.3.3/flatly/bootstrap.min.css",
                 "integrity": "sha512-qoT4KwnRpAQ9uczPsw7GunsNmhRnYwSlE2KRCUPRQHSkDuLulCtDXuC2P/P6oqr3M5hoGagUG9pgHDPkD2zCDA=="

allianceauth/theme/hooks.py

@@ -1,10 +1,10 @@
-from typing import List, Optional
+from typing import List, Optional, Union
 
 
 class ThemeHook:
     """
-        Theme hook for injecting a Bootstrap 5 Theme and associated JS into alliance auth.
-        these can be local or CDN delivered
+    Theme hook for injecting a Bootstrap 5 Theme and associated JS into alliance auth.
+    These can be local or CDN delivered.
     """
 
     def __init__(self,
@@ -14,7 +14,7 @@ class ThemeHook:
                 js: List[dict],
                 css_template: Optional[str] = None,
                 js_template: Optional[str] = None,
-                html_tags: Optional[str] = "",
+                html_tags: Optional[Union[dict, str]] = None,
                 header_padding: Optional[str] = "4em"):
         """
         :param name: Theme python name
@@ -29,6 +29,10 @@ class ThemeHook:
         :type css_template: Optional[str], optional
         :param js_template: _description_, defaults to None
         :type js_template: Optional[str], optional
+        :param html_tags: Attributes added to the `<html>` tag, defaults to None
+        :type html_tags: Optional[dict|str], optional
+        :param header_padding: Top padding, defaults to "4em"
+        :type header_padding: Optional[str], optional
         """
         self.name = name
         self.description = description
@@ -41,7 +45,11 @@ class ThemeHook:
         self.css_template = css_template
         self.js_template = js_template
 
-        self.html_tags = html_tags
+        self.html_tags = (
+            " ".join([f"{key}={value}" for key, value in html_tags.items()])
+            if isinstance(html_tags, dict)
+            else html_tags
+        )
         self.header_padding = header_padding
     def get_name(self):
         return f"{self.__class__.__module__}.{self.__class__.__name__}"

allianceauth/theme/materia/auth_hooks.py

@@ -13,6 +13,7 @@ class MateriaThemeHook(ThemeHook):
             self,
             "Materia",
             "Material is the metaphor",
+            html_tags={"data-theme": "materia"},
             css=[{
                 "url": "https://cdnjs.cloudflare.com/ajax/libs/bootswatch/5.3.3/materia/bootstrap.min.css",
                 "integrity": "sha512-2S9Do+uTmZmmJpdmAcOKdUrK/YslcvAuRfIF2ws8+BW9AvZXMRZM+o8Wq+PZrfISD6ZlIaeCWWZAdeprXIoYuQ=="

allianceauth/timerboard/templates/timerboard/dashboard.timers.html

@@ -1,59 +1,59 @@
 {% load i18n %}
 {% load evelinks %}
 
-<div class="col-12 align-self-stretch py-2">
+<div class="col-12 mb-3">
     <div class="card h-100">
         <div class="card-body">
-            <h4 class="card-title text-center">{% translate "Upcoming Timers" %}</h4>
-            <div class="card-body">
-                <div>
-                    <table class="table">
-                        <thead>
-                            <tr>
-                                <th class="text-center">{% translate "Details" %}</th>
-                                <th class="text-center">{% translate "Timer" %}</th>
-                                <th class="text-center">{% translate "Type" %}</th>
-                                <th class="text-center">{% translate "System" %}</th>
-                                <th class="text-center">{% translate "EVE Time" %}</th>
-                            </tr>
-                        </thead>
+            {% translate "Upcoming Timers" as widget_title %}
+            {% include "framework/dashboard/widget-title.html" with title=widget_title %}
 
-                        <tbody>
-                            {% for timer in timers %}
-                                <tr>
-                                    <td class="text-center">
-                                        {{ timer.details }}
-                                    </td>
-                                    <td class="text-center">
-                                        {{ timer.get_timer_type_display }}
-                                    </td>
-                                    <td class="text-center" nowrap>
-                                        {% if timer.objective == "Hostile" %}
-                                            <div class="badge bg-danger">
-                                                {% translate "Hostile" %}
-                                            </div>
-                                        {% endif %}
-                                        {% if timer.objective == "Friendly" %}
-                                            <div class="badge bg-primary">
-                                                {% translate "Friendly" %}
-                                            </div>
-                                        {% endif %}
-                                        {% if timer.objective == "Neutral" %}
-                                            <div class="badge bg-default">
-                                                {% translate "Neutral" %}
-                                            </div>
-                                        {% endif %}
-                                    </td>
-                                    <td class="text-center"><a href="{{ timer.system|dotlan_solar_system_url }}">
-                                        {{ timer.system }} {{ timer.planet_moon }}
-                                        </a>
-                                    </td>
-                                    <td class="text-center" nowrap>{{ timer.eve_time | date:"Y-m-d H:i" }}</td>
-                                </tr>
-                            {% endfor %}
-                        </tbody>
-                    </table>
-                </div>
+            <div>
+                <table class="table">
+                    <thead>
+                        <tr>
+                            <th class="text-center">{% translate "Details" %}</th>
+                            <th class="text-center">{% translate "Timer" %}</th>
+                            <th class="text-center">{% translate "Type" %}</th>
+                            <th class="text-center">{% translate "System" %}</th>
+                            <th class="text-center">{% translate "EVE Time" %}</th>
+                        </tr>
+                    </thead>
+
+                    <tbody>
+                        {% for timer in timers %}
+                            <tr>
+                                <td class="text-center">
+                                    {{ timer.details }}
+                                </td>
+                                <td class="text-center">
+                                    {{ timer.get_timer_type_display }}
+                                </td>
+                                <td class="text-center" nowrap>
+                                    {% if timer.objective == "Hostile" %}
+                                        <div class="badge bg-danger">
+                                            {% translate "Hostile" %}
+                                        </div>
+                                    {% endif %}
+                                    {% if timer.objective == "Friendly" %}
+                                        <div class="badge bg-primary">
+                                            {% translate "Friendly" %}
+                                        </div>
+                                    {% endif %}
+                                    {% if timer.objective == "Neutral" %}
+                                        <div class="badge bg-default">
+                                            {% translate "Neutral" %}
+                                        </div>
+                                    {% endif %}
+                                </td>
+                                <td class="text-center"><a href="{{ timer.system|dotlan_solar_system_url }}">
+                                    {{ timer.system }} {{ timer.planet_moon }}
+                                    </a>
+                                </td>
+                                <td class="text-center" nowrap>{{ timer.eve_time | date:"Y-m-d H:i" }}</td>
+                            </tr>
+                        {% endfor %}
+                    </tbody>
+                </table>
             </div>
         </div>
     </div>

allianceauth/timerboard/views.py

@@ -97,7 +97,7 @@ class EditTimerView(TimerManagementView, AddUpdateMixin, UpdateView):
 
 
 class RemoveTimerView(TimerManagementView, DeleteView):
-    form_class = TimerForm
+    pass
 
 
 def dashboard_timers(request):

docker/.env.example

@@ -1,7 +1,7 @@
 PROTOCOL=https://
 AUTH_SUBDOMAIN=%AUTH_SUBDOMAIN%
 DOMAIN=%DOMAIN%
-AA_DOCKER_TAG=registry.gitlab.com/allianceauth/allianceauth/auth:v4.0.2
+AA_DOCKER_TAG=registry.gitlab.com/allianceauth/allianceauth/auth:v4.2.2
 
 # Nginx Proxy Manager
 PROXY_HTTP_PORT=80

docker/Dockerfile

@@ -1,5 +1,5 @@
 FROM python:3.11-slim
-ARG AUTH_VERSION=v4.0.2
+ARG AUTH_VERSION=v4.2.2
 ARG AUTH_PACKAGE=allianceauth==${AUTH_VERSION}
 ENV AUTH_USER=allianceauth
 ENV AUTH_GROUP=allianceauth
@@ -9,21 +9,21 @@ ENV AUTH_HOME=/home/allianceauth
 
 # Setup user and directory permissions
 SHELL ["/bin/bash", "-c"]
-RUN groupadd -g 61000 ${AUTH_GROUP}
-RUN useradd -g 61000 -l -M -s /bin/false -u 61000 ${AUTH_USER}
-RUN mkdir -p ${STATIC_BASE} \
-    && chown ${AUTH_USERGROUP} ${STATIC_BASE} \
-    && mkdir -p ${AUTH_HOME} \
-    && chown ${AUTH_USERGROUP} ${AUTH_HOME}
+RUN groupadd -g 61000 ${AUTH_GROUP} && \
+    useradd -g 61000 -l -m -s /bin/false -u 61000 ${AUTH_USER}
 
-# Install build dependencies
-RUN apt-get update && apt-get upgrade -y && apt-get install -y \
-    libmariadb-dev gcc git pkg-config
+RUN mkdir -p ${STATIC_BASE}/myauth/static \
+    && chown ${AUTH_USERGROUP} ${STATIC_BASE}/myauth/static
 
-# Install python dependencies
-RUN pip install --upgrade pip
-RUN pip install wheel gunicorn
-RUN pip install ${AUTH_PACKAGE}
+# Install Build Dependencies
+RUN apt-get update \
+    && apt-get upgrade -y  \
+    && apt-get install -y --no-install-recommends libmariadb-dev gcc git pkg-config \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install AA and Dependencies
+RUN pip install --no-cache-dir ${AUTH_PACKAGE} gunicorn
 
 # Switch to non-root user
 USER ${AUTH_USER}
@@ -33,7 +33,6 @@ WORKDIR ${AUTH_HOME}
 RUN allianceauth start myauth
 COPY /allianceauth/project_template/project_name/settings/local.py ${AUTH_HOME}/myauth/myauth/settings/local.py
 RUN allianceauth update myauth
-RUN mkdir -p ${STATIC_BASE}/myauth/static
 
 RUN echo 'alias auth="python $AUTH_HOME/myauth/manage.py"' >> ~/.bashrc && \
     source ~/.bashrc

docker/conf/celery.py

@@ -9,6 +9,10 @@ from django.conf import settings  # noqa
 
 app = Celery('myauth')
 
+# Automatically try to establish the connection to the AMQP broker on
+# Celery startup if it is unavailable.
+app.conf.broker_connection_retry_on_startup = True
+
 # Using a string here means the worker don't have to serialize
 # the configuration object to child processes.
 app.config_from_object('django.conf:settings')

docker/conf/nginx.conf

@@ -1,20 +1,28 @@
-server {
-    listen 80;
-    location = /favicon.ico { access_log off; log_not_found off; }
-    location /static {
-        alias /var/www/myauth/static;
-        autoindex off;
-    }
+events {}
+http {
+    include       mime.types;
+    default_type  application/octet-stream;
 
-    location /robots.txt {
-        alias /var/www/myauth/static/robots.txt;
-    }
+    sendfile        on;
 
-    location / {
-        proxy_pass http://allianceauth_gunicorn:8000;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header Host $host;
-        proxy_set_header  X-Real-IP   $remote_addr;
-        proxy_redirect off;
+    server {
+        listen 80;
+        location = /favicon.ico { access_log off; log_not_found off; }
+        location /static {
+            alias /var/www/myauth/static;
+            autoindex off;
+        }
+
+        location /robots.txt {
+            alias /var/www/myauth/static/robots.txt;
+        }
+
+        location / {
+            proxy_pass http://allianceauth_gunicorn:8000;
+            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+            proxy_set_header Host $host;
+            proxy_set_header  X-Real-IP   $remote_addr;
+            proxy_redirect off;
+        }
     }
 }

docker/custom.dockerfile

@@ -1,6 +1,8 @@
 ARG AA_DOCKER_TAG
 FROM $AA_DOCKER_TAG
 
-RUN cd /home/allianceauth
+WORKDIR ${AUTH_HOME}
+
 COPY /conf/requirements.txt requirements.txt
-RUN pip install -r requirements.txt
+RUN --mount=type=cache,target=~/.cache \
+    pip install -r requirements.txt

docker/docker-compose.yml

@@ -62,10 +62,10 @@ services:
         max-file: "5"
 
   nginx:
-    image: nginx:1.25
+    image: nginx:stable
     restart: always
     volumes:
-      - ./conf/nginx.conf:/etc/nginx/conf.d/default.conf
+      - ./conf/nginx.conf:/etc/nginx/nginx.conf
       - static-volume:/var/www/myauth/static
     depends_on:
       - allianceauth_gunicorn

docs/development/custom/framework/api.md

@@ -36,7 +36,7 @@ from allianceauth.framework.api.evecharacter import get_user_from_evecharacter
 user = get_user_from_evecharacter(character=my_evecharacter)
 ```
 
-Now, `user` is a `User` object, or the sentinel username (see [get_sentinel_user](#get-sentinel-user))
+Now, `user` is a `User` object, or the sentinel username (see [get_sentinel_user](#get_sentinel_user))
 if the `EveCharacter` has no user.
 
 ## User API
@@ -88,7 +88,7 @@ main_character = get_main_character_name_from_user(user=my_user)
 
 Now, `main_character` is a `string` containing the user's main character name.
 If the user has no main character, the username will be returned. If the user is `None`,
-the sentinel username (see [get_sentinel_user](#get-sentinel-user)) will be returned.
+the sentinel username (see [get_sentinel_user](#get_sentinel_user)) will be returned.
 
 ### get_sentinel_user
 

docs/development/custom/framework/templates.md

@@ -8,7 +8,7 @@ have to load specific CSS or JavaScript yourself.
 
 These bundles include DataTables CSS and JS, jQuery Datepicker CSS and JS, jQueryUI CSS and JS, and more.
 
-A full list of bundles we provide can be found here: https://gitlab.com/allianceauth/allianceauth/-/tree/master/allianceauth/templates/bundles
+A full list of bundles we provide can be found here: <https://gitlab.com/allianceauth/allianceauth/-/tree/master/allianceauth/templates/bundles>
 
 To use a bundle, you can use the following code in your template (Example for jQueryUI):
 
@@ -28,6 +28,27 @@ To ensure a unified style language throughout Alliance Auth and Community Apps,
 we also provide a couple of template partials. This collection is bound to grow over
 time, so best have an eye on this page.
 
+### Dashboard Widget Title
+
+To ensure the dashboard widgets have a unified style, we provide a template partial for the widget title.
+
+To use it, you can use the following code in your dashboard widget template:
+
+```django
+<div id="my-app-dashboard-widget" class="col-12 mb-3">
+    <div class="card">
+        <div class="card-body">
+            {% translate "My Widget Title" as widget_title %}
+            {% include "framework/dashboard/widget-title.html" with title=widget_title %}
+
+            <div>
+                <p>My widget content</p>
+            </div>
+        </div>
+    </div>
+</div>
+```
+
 ### Page Header
 
 On some pages you want to have a page header. To make this easier, we provide a template partial for this.

docs/development/custom/integrating-services.md

@@ -122,10 +122,6 @@ class MyService(ServiceHook):
 
 All of your apps defined urlpatterns will then be included in the `URLconf` when the core application starts.
 
-#### self.service_ctrl_template
-
-This is provided as a courtesy and defines the default template to be used with [render_service_ctrl](#render_service_ctrl). You are free to redefine or not use this variable at all.
-
 #### title
 
 This is a property which provides a user-friendly display of your service's name. It will usually do a reasonably good job unless your service name has punctuation or odd capitalization. If this is the case, you should override this method and return a string.
@@ -134,7 +130,7 @@ This is a property which provides a user-friendly display of your service's name
 
 #### self.service_ctrl_template
 
-This is provided as a courtesy and defines the default template to be used with [render_service_ctrl](#render-service-ctrl). You are free to redefine or not use this variable at all.
+This is provided as a courtesy and defines the default template to be used with [render_service_ctrl](#render_service_ctrl). You are free to redefine or not use this variable at all.
 
 #### delete_user
 

docs/development/custom/menu-hooks.md

@@ -18,6 +18,8 @@ The `MenuItemHook` class specifies some parameters/instance variables required f
     :undoc-members:
 ```
 
+## Parameters
+
 ### text
 
 The text shown as menu item, e.g., usually the name of the app.

docs/development/custom/url-hooks.md

@@ -12,6 +12,8 @@ def register_urls():
     return UrlHook(app_name.urls, 'app_name', r^'app_name/')
 ```
 
+### Parameters
+
 #### urls
 
 The urls module to include. See [the Django docs](https://docs.djangoproject.com/en/dev/topics/http/urls/#example) for designing urlpatterns.

docs/features/services/discord.md

@@ -50,6 +50,7 @@ Update your auth project's settings file, inputting the server ID as `DISCORD_GU
 :::{note}
 If you already have a Discord server, skip the creation step, but be sure to retrieve the server ID
 :::
+
 ### Registering an Application
 
 Navigate to the [Discord Developers site.](https://discord.com/developers/applications/me) Press the plus sign to create a new application.
@@ -112,6 +113,7 @@ Role names on Discord are case-sensitive, while reserved group names on Auth are
 .. seealso::
     For more information see :ref:`ref-reserved-group-names`.
 ```
+
 ## Tasks
 
 The Discord service contains a number of tasks that can be run to manually perform updates to all users.
@@ -132,6 +134,7 @@ Name                     Description
 `update_all`             Update groups, nicknames, usernames of all users
 ======================== ====================================================
 ```
+
 :::{note}
 Depending on how many users you have, running these tasks can take considerable time to finish. You can calculate roughly 1 sec per user for all tasks, except update_all, which needs roughly 3 secs per user.
 :::
@@ -156,6 +159,7 @@ Name                                Description
 `DISCORD_TASKS_MAX_RETRIES`         max retries of tasks after an error occurred                                                  `3`
 =================================== ============================================================================================= =======
 ```
+
 ## Permissions
 
 To use this service, users will require some of the following.
@@ -167,6 +171,7 @@ To use this service, users will require some of the following.
 | discord.access_discord                | None             | Can Access the Discord Service                                           |
 +---------------------------------------+------------------+--------------------------------------------------------------------------+
 ```
+
 ## Troubleshooting
 
 ### "Unknown Error" on Discord site when activating service

docs/features/services/mumble-docker.md

@@ -1,4 +1,4 @@
-# Mumble
+# Mumble (Docker)
 
 An alternate install guide for Mumble using Docker, better suited to an Alliance Auth Docker install
 

docs/features/services/nameformats.md

@@ -29,6 +29,7 @@ Currently, the following services support custom name formats:
 | Xenforo     | Username  | ``{character_name}``                |
 +-------------+-----------+-------------------------------------+
 ```
+
 :::{note}
 It's important to note here, before we get into what you can do with a name formatter, that before the generated name is passed off to the service to create an account it will be sanitized to remove characters (the letters and numbers etc.) that the service cannot support. This means that, despite what you configured, the service may display something different. It is up to you to test your formatter and understand how your format may be disrupted by a certain services sanitization function.
 :::

docs/features/services/openfire-docker.md

@@ -1,4 +1,4 @@
-# Openfire
+# Openfire (Docker)
 
 An alternate install guide for Openfire using Docker, better suited to an Alliance Auth Docker install
 

docs/features/services/teamspeak3-docker.md

@@ -1,4 +1,4 @@
-# TeamSpeak 3
+# TeamSpeak 3 (Docker)
 
 ## Overview
 

docs/installation/allianceauth.md

@@ -181,13 +181,17 @@ If you don't plan on running the database on the same server as auth you still n
 
 ### Redis and Other Tools
 
-A few extra utilities are also required for installation of packages.
+A few extra utilities are also required for the installation of packages.
 
 ::::{tabs}
 
 :::{group-tab} Ubuntu 2004, 2204
 
 ```shell
+curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg
+sudo chmod 644 /usr/share/keyrings/redis-archive-keyring.gpg
+echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list
+sudo apt-get update
 sudo apt-get install unzip git redis-server curl libssl-dev libbz2-dev libffi-dev build-essential pkg-config
 ```
 

docs/installation/apache.md

@@ -11,21 +11,28 @@ If you're using a small VPS to host services with very limited memory, consider
 ::::{tabs}
 
 :::{group-tab} Ubuntu 2004, 2204
+
 ```shell
 apt-get install apache2
 ```
+
 :::
 :::{group-tab} CentOS 7
+
 ```shell
 yum install httpd
 ```
+
 :::
 :::{group-tab} CentOS Stream 8
+
 ```shell
 dnf install httpd
 ```
+
 :::
 :::{group-tab} CentOS Stream 9
+
 ```shell
 systemctl enable httpd
 systemctl start httpd
@@ -36,7 +43,6 @@ systemctl start httpd
 
 CentOS 7, Stream 8, Stream 9
 
-
 ## Configuration
 
 ### Permissions

docs/maintenance/troubleshooting.md

@@ -6,11 +6,47 @@ In its default configuration, your auth project logs INFO and higher messages to
 
 To record DEBUG messages in the log file, alter a setting in your auth project's settings file: `LOGGING['handlers']['log_file']['level'] = 'DEBUG'`. After restarting gunicorn and celery, your log file will record all logging messages.
 
+## Steps to Check Logs for Errors
+
+### Locate the Logs
+
+The logs are located within the `myauth/log/` directory of your Alliance Auth project.
+
+### Access the Logs
+
+Use a text editor or terminal commands (like `tail -f <filename>`) to open the relevant log files.
+
+_(The `tail -f` command displays the last few lines of a file and then continues to monitor the file, printing any new lines that are added in real-time. Useful to watch while actively testing a troublesome feature while troubleshooting.)_
+
+Consider the following:
+
+`allianceauth.log` is the primary log for general troubleshooting. Tracks user actions, changes made, and potential errors.
+
+`worker.log` is important for issues related to background tasks.(Such as services(Discord)).
+
+`beat.log` if you suspect scheduler problems.
+
+`gunicorn.log` for web-specific or Gunicorn worker errors.
+
+### Search for Errors
+
+Look for keywords like `ERROR`, `WARNING`, `EXCEPTION`, or `CRITICAL`. Examine timestamps to correlate errors with user actions or events. Read the error messages carefully for clues about the problem's nature.
+
+Troubleshooting Tips:
+
+**Filter Logs:** Use tools like `grep` to filter logs based on keywords or timeframes, making it easier to focus on relevant information.
+
+**Example**: `tail -f worker.log | grep -i 'discord'`. This will isolate lines containing discord. Making it easier to see among the other logs.
+
+**Debug Mode:** For in-depth troubleshooting, temporarily enable DEBUG logging in your `local.py` to get more detailed messages. Remember to set it back to `False` after debugging.
+
+**Important Note: Before sharing logs publicly, sanitize any sensitive information such as usernames, passwords, or API keys.**
+
 ## Common Problems
 
 ### I'm getting error 500 when trying to connect to the website on a new installation
 
-*Great.* Error 500 is the generic message given by your web server when *anything* breaks. The actual error message is hidden in one of your auth project's log files. Read them to identify it.
+_Great._ Error 500 is the generic message given by your web server when _anything_ breaks. The actual error message is hidden in one of your auth project's log files. Read them to identify it.
 
 ### Failed to configure log handler
 

docs/maintenance/tuning/gunicorn.md

@@ -1,13 +0,0 @@
-# Gunicorn
-
-## Number of workers
-
-The default installation will have 3 workers configured for Gunicorn. This will be fine on most systems, but if your system as more than one core than you might want to increase the number of workers to get better response times. Note that more workers will also need more RAM though.
-
-The number you set this to will depend on your own server environment, how many visitors you have etc. Gunicorn suggests `(2 x $num_cores) + 1` for the number of workers. So for example, if you have 2 cores, you want 2 x 2 + 1 = 5 workers. See [here](https://docs.gunicorn.org/en/stable/design.html#how-many-workers) for the official discussion on this topic.
-
-For example, to get 5 workers change the setting `--workers=5` in your `supervisor.conf` file and then reload the supervisor with the following command to activate the change (Ubuntu):
-
-```shell
-systemctl restart supervisor
-```

docs/maintenance/tuning/web.md

@@ -0,0 +1,156 @@
+# Web Tuning
+
+## Gunicorn
+
+### Number of workers
+
+The default installation will have 3 workers configured for Gunicorn. This will be fine on most systems, but if your system as more than one core than you might want to increase the number of workers to get better response times. Note that more workers will also need more RAM though.
+
+The number you set this to will depend on your own server environment, how many visitors you have etc. Gunicorn suggests `(2 x $num_cores) + 1` for the number of workers. So for example, if you have 2 cores, you want 2 x 2 + 1 = 5 workers. See [here](https://docs.gunicorn.org/en/stable/design.html#how-many-workers) for the official discussion on this topic.
+
+::::{tabs}
+:::{group-tab} Ubuntu 2204, 2404
+To have 5 workers change the setting `--workers=x` to `--workers=5` in your `supervisor.conf` file and then reload the supervisor with the following command to activate the change
+
+```shell
+systemctl restart supervisor
+```
+
+:::
+:::{group-tab} CentOS / RHEL
+To have 5 workers change the setting `--workers=x` to `--workers=5` in your `supervisor.conf` file and then reload the supervisor with the following command to activate the change
+
+```shell
+systemctl restart supervisor
+```
+
+:::
+:::{group-tab} Docker Compose
+To have 5 workers change the setting `--workers=3` to `--workers=5` in your `docker-compose.yml` file and then restart the container as follows
+
+```shell
+docker compose up -d
+```
+
+:::
+::::
+
+## nginx
+
+### nginx repo
+
+We can use the Nginx repositories for a slightly more cutting edge version of Nginx, with more features. Install it to enable the below features
+
+::::{tabs}
+:::{group-tab} Ubuntu 2204, 2404
+<https://nginx.org/en/linux_packages.html#Ubuntu>
+:::
+:::{group-tab} CentOS / RHEL
+<https://nginx.org/en/linux_packages.html#RHEL>
+:::
+:::{group-tab} Docker
+No package necessary, simply increase `docker compose pull` and `docker compose up -d` to update.
+:::
+::::
+
+### Brotli Compression
+
+Brotli is a modern compression algorithm designed for the web. Use this with Pre-Compression and E2E Cloudflare compression for best results.
+
+::::{tabs}
+:::{group-tab} Ubuntu 2204, 2404
+sudo apt update
+sudo apt install libnginx-mod-http-brotli-filter libnginx-mod-http-brotli-static
+:::
+:::{group-tab} CentOS
+WIP
+:::
+:::{group-tab} Docker
+Pull a custom dockerfile
+
+```bash
+mkdir nginx
+curl -o my-nginx/Dockerfile https://raw.githubusercontent.com/nginxinc/docker-nginx/master/modules/Dockerfile
+```
+
+Replace the nginx service in your docker-compose as follows
+
+```dockerfile
+  nginx:
+    build:
+      context: ./nginx/
+      args:
+        ENABLED_MODULES: brotli
+    restart: always
+    volumes:
+      - ./conf/nginx.conf:/etc/nginx/nginx.conf
+      - static-volume:/var/www/myauth/static
+    depends_on:
+      - allianceauth_gunicorn
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "10Mb"
+        max-file: "5"
+```
+
+:::
+::::
+
+Modify your nginx.conf as follows
+
+```conf
+load_module modules/ngx_http_brotli_static_module.so;
+load_module modules/ngx_http_brotli_filter_module.so;
+...
+http {
+  ...
+    server {
+        ...
+        location /static {
+            ...
+            brotli_static on;
+            brotli_types application/javascript text/css font/woff2 image/png image/svg+xml font/woff image/gif;
+            brotli_comp_level 11;
+        }
+        ...
+        location / {
+            ...
+            brotli on;
+            brotli_comp_level 4;
+        }
+    }
+}
+```
+
+### Staticfile Pre-Compression
+
+We can use a small library to pre-compress staticfiles for Nginx to deliver.
+
+```shell
+pip install django-static-compress
+```
+
+Add the following lines to local.py
+
+```python
+# Tuning / Compression
+STORAGES = {
+    "staticfiles": {
+        "BACKEND": "static_compress.CompressedStaticFilesStorage",
+    },
+}
+
+STATIC_COMPRESS_FILE_EXTS = ['js', 'css', 'woff2', 'png', 'svg', 'woff', 'gif']
+STATIC_COMPRESS_METHODS = ['gz', 'br']
+STATIC_COMPRESS_KEEP_ORIGINAL = True
+STATIC_COMPRESS_MIN_SIZE_KB = 1
+```
+
+## Cloudflare
+
+### Brotli E2E Compression
+
+Soon to be turned on by default. Refer to <https://developers.cloudflare.com/speed/optimization/content/brotli/enable/>
+
+In order for cloudflare to seamlessly pass on your brotli compressed pages (End to End), ensure minification, rocket loader and other features are _off_ <https://developers.cloudflare.com/speed/optimization/content/brotli/enable/#notes-about-end-to-end-compression>. Else cloudflare will need to uncompress, modify, then recompress your pages.

pyproject.toml

@@ -18,6 +18,7 @@ authors = [
 requires-python = ">=3.8"
 classifiers = [
     "Environment :: Web Environment",
+    "Framework :: Celery",
     "Framework :: Django",
     "Framework :: Django :: 4.2",
     "Intended Audience :: Developers",
@@ -49,6 +50,7 @@ dependencies = [
     "django-esi>=5",
     "django-redis>=5.2",
     "django-registration<3.4,>=3.3",
+    "django-solo",
     "django-sortedm2m",
     "dnspython",
     "mysqlclient>=2.1",

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-isolated_build = True
+isolated_build = true
 skipsdist = true
 usedevelop = true
 envlist = py{38,39,310,311,312}-{all,core}, docs