Add option to serve with URL prefix #2008
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added the option to run Doccano with a URL prefix instead of always running from the domain root. The prefix is configured by specifying a `BASE_URL` environment variable. To run Doccano under `/doccano/`, set `BASE_URL` to '/doccano/': ```sh export BASE_URL=/doccano/ ``` When we now compile the front-end, all routes are prefixed with BASE_URL. We also need to let Django know about our new prefix. This is done using the same BASE_URL, but needs to be set during runtime. I could not find a clean method to do them both during runtime. Since such a configuration will most likely only be used in combination with a load balancer, I also added the option to set `USE_X_FORWARDED_HOST` using environment variables.
|
Thanks! Please write some test cases. After that, I'll merge this PR. |
Note that these URLs should probably not be defined in the view anyways. I patched them here because I am not familiar enough with the project to fix this cleanly.
|
Great, will do. Any tips about where to start for someone unfamiliar with the project (and Django in general)? I expect I should extend |
|
Still in progress? @Vinno97 |
|
This hasn't been on my radar for quite a long time. The project I needed this fix for, was finished up a while ago. I'd be willing to write some tests for it, but I'm still equally unfamiliar with the project and Django. So some pointers will be needed |
Hironsan
reviewed
Jul 4, 2023
| @@ -245,7 +249,7 @@ | |||
|
|
|||
| # User media files | |||
| MEDIA_ROOT = env("MEDIA_ROOT", path.join(BASE_DIR, "media")) | |||
| MEDIA_URL = "/media/" | |||
| MEDIA_URL = BASE_URL + "/media/" | |||
Hironsan
reviewed
Jul 4, 2023
Comment on lines
+67
to
+68
| if settings.BASE_URL: | ||
| urlpatterns = [path(f'{settings.BASE_URL.strip("/")}/', include(urlpatterns))] |
There was a problem hiding this comment.
These lines seem to make the URL (e.g. http://127.0.0.1:8000/v1/projects) inaccessible. settings.BASE_URL is evaluated as True.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added the option to run Doccano with a URL prefix instead of always running from the domain root. The prefix is configured by specifying a
BASE_URLenvironment variable. This PR fixes #1878To run Doccano under
/doccano/, setBASE_URLto/doccano/:export BASE_URL=/doccano/When we now compile the front-end, all routes are prefixed with BASE_URL.
We also need to let Django know about our new prefix. This is done using the same BASE_URL environment variable but needs to be set during runtime. I could not find a clean method to configure them both during runtime.
Since such a configuration will most likely only be used in combination with a load balancer, I also added the option to set
USE_X_FORWARDED_HOSTusing environment variables.Note that I did not write any tests for this (yet), both because I am unsure how this should be done and because I would first like to know if this PR would be acceptable.