feat: add optional BASE_PATH to Docker config #1378
Merged
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.
While working with redoc I came accross the lack of a "base path" option in the provided Docker image.
My use case is that I have redoc running behind a reverse proxy routing via path matching. E.g. the reverse proxy receives a request to
<host>/docs
, strips the request URL of/docs
and forwards it to redoc. The way index.tpl.html is constructed, it tries to load favicon.png from<host>/favicon.png
. The workaround is to send requests to<host>/docs/
instead, where it'll be correctly loaded from<host>/docs/favicon.png
, but this feels dirty.Setting
BASE_PATH
to/docs/
will prepend favicon.png, making it load from<host>/docs/favicon.png
no matter the original request.A possible alternative to this could be allowing users to specify BUNDLE_URL or similar, which defaults to
redoc.standalone.js
. That way, users could set BUNDLE_URL to/docs/redoc.standalone.js
and PAGE_FAVICON to/docs/favicon.png
. Another possible alternative could be to modify the nginx config.I'd be happy to make adjustments.