Add PAPERLESS_LOGOUT_REDIRECT_URL

When set, the user is redirected to this URL after a logout. Especially useful in conjunction with PAPERLESS_ENABLE_HTTP_REMOTE_USER and SSO.
jonaswinkler · Aug 26, 2021 · bf2cdae · bf2cdae
1 parent cd43bc1
commit bf2cdae
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -233,6 +233,13 @@ PAPERLESS_HTTP_REMOTE_USER_HEADER_NAME=<str>
 
     Defaults to `HTTP_REMOTE_USER`.
 
+PAPERLESS_LOGOUT_REDIRECT_URL=<str>
+    URL to redirect the user to after a logout. This can be used together with
+    `PAPERLESS_ENABLE_HTTP_REMOTE_USER` to redirect the user back to the SSO
+    application's logout page.
+
+    Defaults to None, which disables this feature.
+
 .. _configuration-ocr:
 
 OCR settings

diff --git a/src/paperless/settings.py b/src/paperless/settings.py
@@ -144,6 +144,7 @@ def __get_boolean(key, default="NO"):
 FORCE_SCRIPT_NAME = os.getenv("PAPERLESS_FORCE_SCRIPT_NAME")
 BASE_URL = (FORCE_SCRIPT_NAME or "") + "/"
 LOGIN_URL = BASE_URL + "accounts/login/"
+LOGOUT_REDIRECT_URL = os.getenv("PAPERLESS_LOGOUT_REDIRECT_URL")
 
 WSGI_APPLICATION = 'paperless.wsgi.application'
 ASGI_APPLICATION = "paperless.asgi.application"