Document configurable session lifetimes, and complete the config.php example - #573
Draft
imorland wants to merge 3 commits into
Draft
Document configurable session lifetimes, and complete the config.php example#573imorland wants to merge 3 commits into
imorland wants to merge 3 commits into
Conversation
Adds a Sessions section covering the new session block in config.php, and fills in the 2.1 changes page with the access token extender. The example at the top of the config page said it was an overview of everything while leaving out safe_mode_extensions, the cookie options, session.driver, database.prefix_indexes and the announcements key. Checked each key against core rather than the existing block.
Which values env() converts, that numbers stay strings, and what to do for options expecting an array.
They ship in 2.0, not 2.1.
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 changes.
A Sessions section in
config.mdcovering the newsessionblock: the three keys, a table of what each token type governs, and the config-takes-precedence behaviour. It notes that logins through another service are alwayssession_remember, since there's no "remember me" checkbox on those — on a forum where most people sign in that way, it's the only value that matters.The example block at the top now shows every option core reads. It said "here's a quick overview" while omitting
safe_mode_extensions, all fivecookie.*options,session.driver,database.prefix_indexesandflarum_announcements.disabled. I checked each key against the source rather than working from the existing block.Also fills in the empty "2.1 Changes" section of
update-2_x.mdwith theExtend\AccessTokenextender,lifetime()vs the$lifetimedefault, and therememberCookieLifeTime()deprecation.Framework: flarum/framework#4918