Skip to content

docs: add documentation for admin cli#832

Open
jnfrati wants to merge 2 commits into
mainfrom
docs/admin-cli
Open

docs: add documentation for admin cli#832
jnfrati wants to merge 2 commits into
mainfrom
docs/admin-cli

Conversation

@jnfrati

@jnfrati jnfrati commented Jul 7, 2026

Copy link
Copy Markdown
Contributor
localhost_3000_selfhosted_maintenance_admin-cli (2)

Summary by CodeRabbit

  • Documentation
    • Added a new self-hosted Admin CLI documentation page, including commands for local user password changes, local MFA management, and reverse proxy access tokens.
    • Updated identity provider docs with administrator instructions for resetting local user passwords and managing local MFA via the Admin CLI.
    • Standardized CLI examples for creating/listing/revoking proxy access tokens across scaling and reverse proxy enablement pages.
  • New Features
    • Added an Admin CLI entry to the self-hosted Maintenance navigation.

@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d1d870b1-6410-4057-8e5d-b9bae2b1c6c4

📥 Commits

Reviewing files that changed from the base of the PR and between cb03de8 and 0b15e84.

📒 Files selected for processing (1)
  • src/components/NavigationDocs.jsx
✅ Files skipped from review due to trivial changes (1)
  • src/components/NavigationDocs.jsx

📝 Walkthrough

Walkthrough

This PR adds a new self-hosted admin CLI documentation page, links it from the Maintenance navigation and related identity-provider docs, and updates proxy token examples in scaling and migration docs to use the admin token command form.

Changes

Admin CLI documentation and cross-linking

Layer / File(s) Summary
Admin CLI reference and user operations
src/pages/selfhosted/maintenance/admin-cli.mdx
Adds the admin CLI page scaffold, overview, command-prefix guidance, local user password change instructions, and local MFA reset instructions.
Local MFA management and notes
src/pages/selfhosted/maintenance/admin-cli.mdx, src/pages/selfhosted/identity-providers/enable-local-mfa.mdx, src/pages/selfhosted/identity-providers/local.mdx
Adds the local MFA management section in the admin CLI page and inserts related notes in the identity-provider docs.
Proxy access token and repair commands
src/pages/selfhosted/maintenance/admin-cli.mdx
Adds proxy access token management, reverse proxy connection repair, and troubleshooting content in the admin CLI page.
Sidebar entry and token command updates
src/components/NavigationDocs.jsx, src/pages/selfhosted/maintenance/scaling/multiple-proxy-instances.mdx, src/pages/selfhosted/migration/enable-reverse-proxy.mdx
Adds the Maintenance sidebar link to the admin CLI page and updates proxy token commands and references in the scaling and migration docs.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

  • netbirdio/docs#704: Both PRs modify local MFA documentation in enable-local-mfa.mdx.
  • netbirdio/docs#799: Both PRs modify docsNavigation entries in the Maintenance section of NavigationDocs.jsx.

Suggested reviewers: SunsetDrifter

Poem

A rabbit hopped in with a grin,
New CLI docs tucked right in.
admin token now leads the way,
And sidebar hops to brighten the day.
Hop, hop — the maintenance path is clear,
With carrots of commands for every hare. 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding self-hosted admin CLI documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/admin-cli

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/components/NavigationDocs.jsx

Oops! Something went wrong! :(

ESLint: 9.39.4

TypeError: Converting circular structure to JSON
--> starting at object with constructor 'Object'
| property 'configs' -> object with constructor 'Object'
| property 'flat' -> object with constructor 'Object'
| ...
| property 'plugins' -> object with constructor 'Object'
--- property 'react' closes the circle
Referenced from:
at JSON.stringify ()
at file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/shared/config-validator.js:308:45
at Array.map ()
at ConfigValidator.formatErrors (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/shared/config-validator.js:299:23)
at ConfigValidator.validateConfigSchema (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/shared/config-validator.js:330:84)
at ConfigArrayFactory._normalizeConfigData (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:676:19)
at ConfigArrayFactory._loadConfigData (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:641:21)
at ConfigArrayFactory._loadExtendedShareableConfig (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:946:21)
at ConfigArrayFactory._loadExtends (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:814:25)
at ConfigArrayFactory._normalizeObjectConfigDataBody (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:752:25)


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant