Document the auth.cookie.secure and flags.docLinks admin options - #3508
Open
yfwmaniish wants to merge 1 commit into
Open
yfwmaniish wants to merge 1 commit into
yfwmaniish wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Both are declared in the admin config type but were missing from the admin panel configuration reference table: - auth.cookie.secure (Secure flag on the admin auth cookie; auto-enabled in production over HTTPS, warns if set to false in production) - flags.docLinks (toggle admin documentation links; default true)
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
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.
Description
Adds two admin configuration options that were missing from the admin panel configuration reference (
docusaurus/docs/cms/configurations/admin-panel.md):auth.cookie.secure— whether theSecureattribute is set on the admin authentication cookie. When unset it is enabled automatically in production over HTTPS, and setting it tofalsein production logs a warning (verified inpackages/core/admin/shared/utils/session-auth.tsandpackages/core/admin/server/src/bootstrap.ts). Theauth.cookietable already documentsname/domain/path/sameSite, so this fills in the missing sibling.flags.docLinks— enable/disable the documentation links displayed in the admin panel (defaulttrue; declared in theFlagsconfig type alongside the already-documentedflags.npsandflags.promoteEE).Both are declared in the admin config type (
packages/core/types/src/core/config/admin.ts) but were not listed in the reference.Related issue(s)/PR(s)
None — found by cross-checking the admin config type against the documentation.