Skip to content

docs: clarify admin_from for privileged commands#393

Open
xukp20 wants to merge 1 commit intochenhg5:mainfrom
xukp20:docs/admin-from-privileged-commands
Open

docs: clarify admin_from for privileged commands#393
xukp20 wants to merge 1 commit intochenhg5:mainfrom
xukp20:docs/admin-from-privileged-commands

Conversation

@xukp20
Copy link
Copy Markdown
Contributor

@xukp20 xukp20 commented Mar 31, 2026

Summary

Clarify how admin_from should be configured for privileged commands such as /dir.

This documents the configuration detail discussed in #359: admin_from must be defined at the [[projects]] level, not under
[projects.platforms.options].

What changed

  • clarify admin_from placement in config.example.toml
  • document that /dir is a privileged command requiring admin_from
  • explain how to obtain the user ID via /whoami or /status
  • document the admin_from = "*" shortcut and its risk in multi-user environments
  • add the same clarification to both English and Chinese usage docs
  • add a short note in README.md

Why

A user in #359 was able to fix the problem after moving admin_from to the correct config level, and suggested documenting it.

This PR makes that guidance explicit so users do not accidentally place admin_from under platform options and wonder why privileged commands are still blocked.

Validation

  • reviewed latest upstream/main before editing
  • go test ./config ./core ./agent/... ./platform/...
  • manual diff review of all doc changes

Note:

  • full go build ./... / go test ./... on a clean latest main checkout is currently blocked by missing web/dist in the repository checkout, which
    is unrelated to this doc-only change

Related issue

Copy link
Copy Markdown
Owner

@chenhg5 chenhg5 left a comment

Choose a reason for hiding this comment

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

LGTM. Helpful documentation clarification.

Review summary:

  • ✅ Clarifies admin_from placement (project level, not platform options)
  • ✅ Documents how to get User ID via /whoami / /status
  • ✅ Bilingual docs updated
  • ✅ CI passes

Addresses the confusion from #359.

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.

2 participants