docs: document CORS_ALLOWED_ORIGINS and fix broken Security page links - #137
Merged
Conversation
Add the CORS_ALLOWED_ORIGINS environment variable to the Installation env table (Maintainerr/Maintainerr#3407). The bundled UI is same-origin with the API and does not need it; it is only for a separate front end. The Security & Authentication page lives in the current docs (/next/security/), but API.md and Configuration.md linked to it with an absolute /security, which resolves to the site root where the page does not exist yet, so the build flagged both as broken. Switch them to version-relative links (./Security.md) so they resolve within whichever version is viewed. docusaurus build now reports no broken links.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Two small documentation fixes.
Document
CORS_ALLOWED_ORIGINS(for Maintainerr/Maintainerr#3407). Adds the new environment variable to the Installation env table. Same-origin access, including the bundled UI via localhost, always works and never needs it; it is only for a separate front end on a different origin.Fix broken Security page links. The Security & Authentication page lives in the current docs (served at
/next/security/), butAPI.mdandConfiguration.mdlinked to it with an absolute/security, which resolves to the site root where the page does not exist yet, so the build flagged both as broken. Switched them to version-relative links (./Security.md) so they resolve within whichever version is viewed, and to/security/at the root once the page is promoted on the next release snapshot.docusaurus buildnow reports no broken links.