From e4953a756a84ee01e9d68c06edd21f08178e0b18 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 8 Apr 2022 00:16:57 -0700 Subject: [PATCH] docs for PAPERLESS_URL + PAPERLESS_CSRF_TRUSTED_ORIGINS --- docs/configuration.rst | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 192fa8513..9a59a80ba 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -142,7 +142,24 @@ PAPERLESS_SECRET_KEY= Default is listed in the file ``src/paperless/settings.py``. -PAPERLESS_ALLOWED_HOSTS +PAPERLESS_URL= + This setting can be used to set the three options below (ALLOWED_HOSTS, + CORS_ALLOWED_HOSTS and CSRF_TRUSTED_ORIGINS). If the other options are + set the values will be combined with this one. Do not include a trailing + slash. E.g. https://paperless.domain.com + + Defaults to empty string, leaving the other settings unaffected. + +PAPERLESS_CSRF_TRUSTED_ORIGINS= + A list of trusted origins for unsafe requests (e.g. POST). As of Django 4.0 + this is required to access the Django admin via the web. + See https://docs.djangoproject.com/en/4.0/ref/settings/#csrf-trusted-origins + + Can also be set using PAPERLESS_URL (see above). + + Defaults to empty string, which does not add any origins to the trusted list. + +PAPERLESS_ALLOWED_HOSTS= If you're planning on putting Paperless on the open internet, then you really should set this value to the domain name you're using. Failing to do so leaves you open to HTTP host header attacks: @@ -151,12 +168,16 @@ PAPERLESS_ALLOWED_HOSTS Just remember that this is a comma-separated list, so "example.com" is fine, as is "example.com,www.example.com", but NOT " example.com" or "example.com," + Can also be set using PAPERLESS_URL (see above). + Defaults to "*", which is all hosts. -PAPERLESS_CORS_ALLOWED_HOSTS +PAPERLESS_CORS_ALLOWED_HOSTS= You need to add your servers to the list of allowed hosts that can do CORS calls. Set this to your public domain name. + Can also be set using PAPERLESS_URL (see above). + Defaults to "http://localhost:8000". PAPERLESS_FORCE_SCRIPT_NAME=