Skip to content

HOLD UNTIL FEATURE AVAILABLE: New Docs for Authcommands feature#232

Open
SigmaScott wants to merge 12 commits into
AllStarLink:mainfrom
SigmaScott:authcommands-docs
Open

HOLD UNTIL FEATURE AVAILABLE: New Docs for Authcommands feature#232
SigmaScott wants to merge 12 commits into
AllStarLink:mainfrom
SigmaScott:authcommands-docs

Conversation

@SigmaScott

Copy link
Copy Markdown

Add TOTP DTMF Authentication Documentation

Summary

Adds end-user documentation for the new per-user TOTP (Time-based One-Time Password) DTMF authentication feature in app_rpt. This feature allows node administrators to gate privileged DTMF commands behind a one-
time password verified via any standard authenticator app (Google Authenticator, Authy, FreeOTP, etc.).

Changes

New Pages

  • docs/adv-topics/totp-auth.md — Full user guide covering:

    • Feature overview and login flow
    • Configuration (rpt.conf node-level keys, function table entries, privileged command stanzas)
    • Setting up users (secret generation, authenticator app enrollment via manual entry or QR code)
    • Day-to-day radio usage (login, use privileged commands, logout)
    • CLI commands (rpt auth show, rpt auth logout)
    • Operational notes (session behavior, time sync, reloads, disabling)
    • Troubleshooting table
  • docs/config/rpt_auth_conf.md — Config file reference for the new rpt_auth.conf user/secret file (format, fields, permissions, examples)

Updated Pages

  • docs/config/rpt_conf.md — Added:

    • auth function class section (after COP commands) documenting the auth,a / auth,s / auth,l methods
    • Six new auth_* node-level configuration keys with descriptions, defaults, and ranges
  • mkdocs.yml — Added navigation entries for both new pages (TOTP Auth under Advanced Topics, rpt_auth.conf under Config Files)

Testing

  • Verified mkdocs build completes without errors
  • All internal cross-references resolve correctly

Notes

  • Documentation is written for end-users/node operators only; no developer internals are exposed
  • Style matches existing manual conventions (admonitions, code blocks, tables, cross-references)

- New advanced topic page: TOTP DTMF Authentication user guide
- New config reference page: rpt_auth.conf
- Add auth_* keys and auth function class to rpt_conf.md
- Update navigation in mkdocs.yml
@coderabbitai

coderabbitai Bot commented May 31, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8aaa38b0-7222-491b-927e-1415d238d4aa

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@jxmx jxmx requested review from Allan-N, jxmx and ve7fet May 31, 2026 17:18
@jxmx jxmx self-assigned this May 31, 2026
@jxmx jxmx added the enhancement New feature or request label May 31, 2026

@Allan-N Allan-N left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like this feature :)

Comment thread docs/config/rpt_auth_conf.md Outdated
Comment thread docs/config/rpt_auth_conf.md Outdated
@Allan-N Allan-N changed the title New Docs for Authcommands feature HOLD MERGE UNTIL FEATURE AVAILABLE: New Docs for Authcommands feature May 31, 2026
@Allan-N Allan-N changed the title HOLD MERGE UNTIL FEATURE AVAILABLE: New Docs for Authcommands feature HOLD UNTIL FEATURE AVAILABLE: New Docs for Authcommands feature May 31, 2026

@ve7fet ve7fet left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@mkmer mkmer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

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

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants