From 6b6862705efdf2582c1fdd2467c5a3644498e21e Mon Sep 17 00:00:00 2001 From: puuu Date: Tue, 11 May 2021 17:25:50 +0900 Subject: [PATCH 1/8] make all links relative --- src-ui/src/app/app.component.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src-ui/src/app/app.component.ts b/src-ui/src/app/app.component.ts index 836a6f66a..2b828d3b0 100644 --- a/src-ui/src/app/app.component.ts +++ b/src-ui/src/app/app.component.ts @@ -18,7 +18,7 @@ export class AppComponent implements OnInit, OnDestroy { constructor (private settings: SettingsService, private consumerStatusService: ConsumerStatusService, private toastService: ToastService, private router: Router) { let anyWindow = (window as any) - anyWindow.pdfWorkerSrc = '/assets/js/pdf.worker.min.js'; + anyWindow.pdfWorkerSrc = 'assets/js/pdf.worker.min.js'; this.settings.updateDarkModeSettings() } From 5bf725546be33d41ff300a916dceb7b16c40991a Mon Sep 17 00:00:00 2001 From: puuu Date: Tue, 11 May 2021 17:28:06 +0900 Subject: [PATCH 2/8] use baseURI for websocket and api calls --- src-ui/src/app/services/consumer-status.service.ts | 2 +- src-ui/src/environments/environment.prod.ts | 7 +++++-- src-ui/src/environments/environment.ts | 3 ++- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src-ui/src/app/services/consumer-status.service.ts b/src-ui/src/app/services/consumer-status.service.ts index e03282175..4a729b29d 100644 --- a/src-ui/src/app/services/consumer-status.service.ts +++ b/src-ui/src/app/services/consumer-status.service.ts @@ -125,7 +125,7 @@ export class ConsumerStatusService { connect() { this.disconnect() - this.statusWebSocket = new WebSocket(`${environment.webSocketProtocol}//${environment.webSocketHost}/ws/status/`); + this.statusWebSocket = new WebSocket(`${environment.webSocketProtocol}//${environment.webSocketHost}${environment.webSocketBaseUrl}status/`); this.statusWebSocket.onmessage = (ev) => { let statusMessage: WebsocketConsumerStatusMessage = JSON.parse(ev['data']) diff --git a/src-ui/src/environments/environment.prod.ts b/src-ui/src/environments/environment.prod.ts index b60824248..54c32d370 100644 --- a/src-ui/src/environments/environment.prod.ts +++ b/src-ui/src/environments/environment.prod.ts @@ -1,9 +1,12 @@ +const base_url = new URL(document.baseURI) + export const environment = { production: true, - apiBaseUrl: "/api/", + apiBaseUrl: document.baseURI + "api/", apiVersion: "2", appTitle: "Paperless-ng", version: "1.4.2", webSocketHost: window.location.host, - webSocketProtocol: (window.location.protocol == "https:" ? "wss:" : "ws:") + webSocketProtocol: (window.location.protocol == "https:" ? "wss:" : "ws:"), + webSocketBaseUrl: base_url.pathname + "ws/", }; diff --git a/src-ui/src/environments/environment.ts b/src-ui/src/environments/environment.ts index 3d981b677..3b8a02e37 100644 --- a/src-ui/src/environments/environment.ts +++ b/src-ui/src/environments/environment.ts @@ -9,7 +9,8 @@ export const environment = { appTitle: "Paperless-ng", version: "DEVELOPMENT", webSocketHost: "localhost:8000", - webSocketProtocol: "ws:" + webSocketProtocol: "ws:", + webSocketBaseUrl: "/ws/", }; /* From c35c4eade9733ba8e64a3c9decc167ffaa817ac7 Mon Sep 17 00:00:00 2001 From: puuu Date: Fri, 14 May 2021 14:03:42 +0900 Subject: [PATCH 3/8] Introduce ConfigurableWorker to make uvicorn respect FORCE_SCRIPT_NAME --- gunicorn.conf.py | 2 +- src/paperless/workers.py | 11 +++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 src/paperless/workers.py diff --git a/gunicorn.conf.py b/gunicorn.conf.py index 995b4fb9d..bcc12490e 100644 --- a/gunicorn.conf.py +++ b/gunicorn.conf.py @@ -2,7 +2,7 @@ import os bind = '0.0.0.0:8000' workers = int(os.getenv("PAPERLESS_WEBSERVER_WORKERS", 2)) -worker_class = 'uvicorn.workers.UvicornWorker' +worker_class = 'paperless.workers.ConfigurableWorker' timeout = 120 def pre_fork(server, worker): diff --git a/src/paperless/workers.py b/src/paperless/workers.py new file mode 100644 index 000000000..4f2f0802a --- /dev/null +++ b/src/paperless/workers.py @@ -0,0 +1,11 @@ +import os +from uvicorn.workers import UvicornWorker +from django.conf import settings + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "paperless.settings") + + +class ConfigurableWorker(UvicornWorker): + CONFIG_KWARGS = { + "root_path": settings.FORCE_SCRIPT_NAME or "", + } From e792a00febae0f046f7de0c96aea3634434ccb3a Mon Sep 17 00:00:00 2001 From: puuu Date: Fri, 14 May 2021 14:20:05 +0900 Subject: [PATCH 4/8] Introduce BASE_URL, make LOGIN_URL and STATIC_URL work with subpath --- src/paperless/settings.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/paperless/settings.py b/src/paperless/settings.py index 26a4d5621..0e9ab53f3 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -142,11 +142,13 @@ MIDDLEWARE = [ ROOT_URLCONF = 'paperless.urls' FORCE_SCRIPT_NAME = os.getenv("PAPERLESS_FORCE_SCRIPT_NAME") +BASE_URL = (FORCE_SCRIPT_NAME or "") + "/" +LOGIN_URL = BASE_URL + "accounts/login/" WSGI_APPLICATION = 'paperless.wsgi.application' ASGI_APPLICATION = "paperless.asgi.application" -STATIC_URL = os.getenv("PAPERLESS_STATIC_URL", "/static/") +STATIC_URL = os.getenv("PAPERLESS_STATIC_URL", "static/") # TODO: what is this used for? TEMPLATES = [ From 56c9b578e39e0d23fbd25c6b6d57d7cb02fb3342 Mon Sep 17 00:00:00 2001 From: puuu Date: Fri, 14 May 2021 14:22:35 +0900 Subject: [PATCH 5/8] Make redirections respect root_path or STATIC_URL, name IndexView --- src/paperless/urls.py | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/src/paperless/urls.py b/src/paperless/urls.py index 7521d49de..eee04af9f 100755 --- a/src/paperless/urls.py +++ b/src/paperless/urls.py @@ -9,6 +9,8 @@ from rest_framework.routers import DefaultRouter from django.utils.translation import gettext_lazy as _ +from django.conf import settings + from paperless.consumers import StatusConsumer from documents.views import ( CorrespondentViewSet, @@ -73,31 +75,36 @@ urlpatterns = [ re_path(r"^fetch/", include([ re_path( r"^doc/(?P\d+)$", - RedirectView.as_view(url='/api/documents/%(pk)s/download/'), + RedirectView.as_view(url=settings.BASE_URL + + 'api/documents/%(pk)s/download/'), ), re_path( r"^thumb/(?P\d+)$", - RedirectView.as_view(url='/api/documents/%(pk)s/thumb/'), + RedirectView.as_view(url=settings.BASE_URL + + 'api/documents/%(pk)s/thumb/'), ), re_path( r"^preview/(?P\d+)$", - RedirectView.as_view(url='/api/documents/%(pk)s/preview/'), + RedirectView.as_view(url=settings.BASE_URL + + 'api/documents/%(pk)s/preview/'), ), ])), re_path(r"^push$", csrf_exempt( - RedirectView.as_view(url='/api/documents/post_document/'))), + RedirectView.as_view(url=settings.BASE_URL + + 'api/documents/post_document/'))), # Frontend assets TODO: this is pretty bad, but it works. path('assets/', - RedirectView.as_view(url='/static/frontend/en-US/assets/%(path)s')), + RedirectView.as_view(url=settings.STATIC_URL + + 'frontend/en-US/assets/%(path)s')), # TODO: with localization, this is even worse! :/ # login, logout path('accounts/', include('django.contrib.auth.urls')), # Root of the Frontent - re_path(r".*", login_required(IndexView.as_view())), + re_path(r".*", login_required(IndexView.as_view()), name='base'), ] From f9b6374685db936611a991de5556f26c320e61e0 Mon Sep 17 00:00:00 2001 From: puuu Date: Fri, 14 May 2021 14:08:02 +0900 Subject: [PATCH 6/8] use {% url %} template to refere to root path --- src/documents/templates/index.html | 2 +- src/documents/templates/registration/logged_out.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/documents/templates/index.html b/src/documents/templates/index.html index 5a7b8c9ba..5c69144de 100644 --- a/src/documents/templates/index.html +++ b/src/documents/templates/index.html @@ -7,7 +7,7 @@ Paperless-ng - + diff --git a/src/documents/templates/registration/logged_out.html b/src/documents/templates/registration/logged_out.html index b1446eb72..64ace025c 100644 --- a/src/documents/templates/registration/logged_out.html +++ b/src/documents/templates/registration/logged_out.html @@ -42,7 +42,7 @@

{% translate "You have been successfully logged out. Bye!" %}

- {% translate "Sign in again" %} + {% translate "Sign in again" %} From 13afd256909ac2f8a459a42107ec388f42c83837 Mon Sep 17 00:00:00 2001 From: puuu Date: Fri, 14 May 2021 15:39:20 +0900 Subject: [PATCH 7/8] Update documentation about PAPERLESS_FORCE_SCRIPT_NAME --- docs/configuration.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 7502cef40..99721b976 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -154,10 +154,6 @@ PAPERLESS_FORCE_SCRIPT_NAME= To host paperless under a subpath url like example.com/paperless you set this value to /paperless. No trailing slash! - .. note:: - - I don't know if this works in paperless-ng. Probably not. - Defaults to none, which hosts paperless at "/". PAPERLESS_STATIC_URL= From 1c2f3cf9af86bafdbd58cafa7884b38f6cc76506 Mon Sep 17 00:00:00 2001 From: puuu Date: Fri, 14 May 2021 18:14:59 +0900 Subject: [PATCH 8/8] Fix serving static files under root_path --- src/paperless/settings.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/paperless/settings.py b/src/paperless/settings.py index 0e9ab53f3..39504fe54 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -148,7 +148,8 @@ LOGIN_URL = BASE_URL + "accounts/login/" WSGI_APPLICATION = 'paperless.wsgi.application' ASGI_APPLICATION = "paperless.asgi.application" -STATIC_URL = os.getenv("PAPERLESS_STATIC_URL", "static/") +STATIC_URL = os.getenv("PAPERLESS_STATIC_URL", BASE_URL + "static/") +WHITENOISE_STATIC_PREFIX = "/static/" # TODO: what is this used for? TEMPLATES = [