Clearer explanation AWS_CUSTOM_DOMAIN + protocol

api/config/settings/common.py

@@ -609,7 +609,20 @@ if AWS_ACCESS_KEY_ID:
     """
     AWS_S3_CUSTOM_DOMAIN = env("AWS_S3_CUSTOM_DOMAIN", default=None)
     """
-    Custom domain to use for your S3 storage.
+    Custom domain for serving your S3 files.
+
+    Useful if your provider offers a CDN-like service for your bucket.
+
+    .. important::
+
+        The URL must not contain a scheme (:attr:`AWS_S3_URL_PROTOCOL` is
+        automatically prepended) nor a trailing slash.
+    """
+    AWS_S3_URL_PROTOCOL = env("AWS_S3_URL_PROTOCOL", default="https:")
+    """
+    Protocol to use when constructing the custom domain (see :attr:`AWS_S3_CUSTOM_DOMAIN`)
+    .. important::
+        It must end with a `:`, remove `//`.
     """
     AWS_S3_ENDPOINT_URL = env("AWS_S3_ENDPOINT_URL", default=None)
     """

changes/changelog.d/aws-custom-domain.doc

@@ -0,0 +1 @@
+Added explanation of AWS_CUSTOM_DOMAIN and AWS_S3_URL_PROTOCOL.

docs/administrator/configuration/object-storage.md

@@ -48,6 +48,8 @@ To set up S3-compatible storage, fill out the relevant details in the `.env` fil
 
 :::{dropdown} Environment variables
 
+Internally, Funkwhale uses the `django-storages` library. See [the documentation](https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html) for more details about environment variables.
+
 ```{eval-rst}
 
 .. autodata:: config.settings.common.AWS_QUERYSTRING_AUTH
@@ -62,6 +64,8 @@ To set up S3-compatible storage, fill out the relevant details in the `.env` fil
    :noindex:
 .. autodata:: config.settings.common.AWS_S3_CUSTOM_DOMAIN
    :noindex:
+.. autodata:: config.settings.common.AWS_S3_URL_PROTOCOL
+   :noindex:
 .. autodata:: config.settings.common.AWS_S3_ENDPOINT_URL
    :noindex:
    :annotation: = https://minio.mydomain.com