docs(multiuser): add README documenting the plugin and its CLI flags#46
Merged
Conversation
The Multiuser plugin (public-gateway / multi-user proxy mode) has no documentation. Operators turning it on hit several rough edges: - `--multiuser-no-new-sites` is a store_true flag; people pass values like `enabled` which argparse silently ignores. - Without `--multiuser-local`, the local operator becomes a regular proxy user and hits "This function (...) is disabled on this proxy!" on admin-only actions. - The newer `NoNewSites` plugin overlaps in purpose but isn't cross-referenced anywhere. Add a README covering: when to enable the plugin, both CLI flags with correct semantics (default values, boolean nature, conf-file form), the admin vs. proxy-user distinction, how to log in as an existing master address, and a pointer to NoNewSites as the simpler alternative. Credit: @mx5kevin (PR #42) flagged that the plugin needed documentation.
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.
Summary
Adds
plugins/disabled-Multiuser/README.mddocumenting the Multiuser plugin (public-gateway / multi-user proxy mode). The plugin has no documentation today; this PR fills that gap.Why now
@mx5kevin's #42 correctly identified that this plugin needs docs — that observation was the valuable part of the PR. The README content in #42 had several factual errors (inverted default values, "edit the Python file" instructions, etc.) so it was closed, but the underlying gap remained. This PR is a corrected version.
In live testing this evening:
--multiuser-no-new-sites enabledproduced no error — argparse silently ignored theenabledtoken because the flag isstore_true. People will try to pass values; the README spells out that they shouldn't.--multiuser-localcaused the local operator to see "This function (serverErrors) is disabled on this proxy!" on admin actions — a confusing UX that's expected behavior, and now documented.NoNewSiteswas unclear; the README now cross-references it as the simpler alternative for read-only gateways.What the README covers
disabled-Multiuser↔Multiuser)users.jsonmembership or--multiuser-local)--multiuser-local: every visitor is admin, users persisted to disk; "unsafe Ui functions" per the flag's own help text--multiuser-no-new-sites:store_true, off by default (i.e. adding sites allowed by default), pass the flag bare with no valueepixnet.confform for persistent configuration--multiuser-local --multiuser-no-new-sitesuserLoginFormwebsocket action)NoNewSitespluginVerification
--multiuser-no-new-sitesisstore_true(MultiuserPlugin.py:276)not config.multiuser_local and self.user.master_address not in local_master_addresses(MultiuserPlugin.py:217)local_master_addressesis loaded from<data-dir>/private/users.json(MultiuserPlugin.py:19)userLoginFormaction exists (MultiuserPlugin.py:197)textCredit
@mx5kevin in #42 for flagging the documentation gap.