MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clearer explanation AWS_CUSTOM_DOMAIN + protocol

This commit is contained in:
Lilou 2024-08-04 14:11:07 +00:00 committed by petitminion
parent 181d39ffbc
commit fb5c863dda
3 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
api/config/settings/common.py
View File

@ -609,7 +609,20 @@ if AWS_ACCESS_KEY_ID:
""" """
AWS_S3_CUSTOM_DOMAIN = env("AWS_S3_CUSTOM_DOMAIN", default=None) 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) AWS_S3_ENDPOINT_URL = env("AWS_S3_ENDPOINT_URL", default=None)
""" """

1
changes/changelog.d/aws-custom-domain.doc Normal file
View File

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

4
docs/administrator/configuration/object-storage.md
View File

@ -48,6 +48,8 @@ To set up S3-compatible storage, fill out the relevant details in the `.env` fil
:::{dropdown} Environment variables :::{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} ```{eval-rst}
.. autodata:: config.settings.common.AWS_QUERYSTRING_AUTH .. 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: :noindex:
.. autodata:: config.settings.common.AWS_S3_CUSTOM_DOMAIN .. autodata:: config.settings.common.AWS_S3_CUSTOM_DOMAIN
:noindex: :noindex:
.. autodata:: config.settings.common.AWS_S3_URL_PROTOCOL
:noindex:
.. autodata:: config.settings.common.AWS_S3_ENDPOINT_URL .. autodata:: config.settings.common.AWS_S3_ENDPOINT_URL
:noindex: :noindex:
:annotation: = https://minio.mydomain.com :annotation: = https://minio.mydomain.com