feat: Add copy to admin command reference index
This commit is contained in:
parent
7b159bc8c8
commit
a028049e6f
2 changed files with 20 additions and 4 deletions
|
|
@ -1,7 +1,15 @@
|
|||
<!-- This file is generated by `cargo xtask generate-docs`. Do not edit. -->
|
||||
# Admin Commands
|
||||
# Admin Command Reference
|
||||
|
||||
These are all the admin commands. TODO fill me out
|
||||
Admin commands allow server administrators to manage the server from within their Matrix client. "Server administrators" by default means only those users which are members of the admin room, but additional server admins may be added using the `admins_list` configuration option.
|
||||
|
||||
## Running commands
|
||||
|
||||
* All commands listed here may be used by server administrators in the admin room by sending them as messages.
|
||||
* If the `admin_escape_commands` configuration option is enabled, server administrators may run certain commands in public rooms by prefixing them with a single backslash. These commands will only run on _their_ homeserver, even if they are a member of another homeserver's admin room. Some sensitive commands cannot be used outside the admin room and will return an error.
|
||||
* All commands listed here may be used in the server's console, if it is enabled. Commands entered in the console do not require the `!admin` prefix.
|
||||
|
||||
## Categories
|
||||
|
||||
- [`!admin appservices`](appservices/) - Commands for managing appservices
|
||||
- [`!admin users`](users/) - Commands for managing local users
|
||||
|
|
|
|||
|
|
@ -1,6 +1,14 @@
|
|||
# Admin Commands
|
||||
# Admin Command Reference
|
||||
|
||||
These are all the admin commands. TODO fill me out
|
||||
Admin commands allow server administrators to manage the server from within their Matrix client. "Server administrators" by default means only those users which are members of the admin room, but additional server admins may be added using the `admins_list` configuration option.
|
||||
|
||||
## Running commands
|
||||
|
||||
* All commands listed here may be used by server administrators in the admin room by sending them as messages.
|
||||
* If the `admin_escape_commands` configuration option is enabled, server administrators may run certain commands in public rooms by prefixing them with a single backslash. These commands will only run on _their_ homeserver, even if they are a member of another homeserver's admin room. Some sensitive commands cannot be used outside the admin room and will return an error.
|
||||
* All commands listed here may be used in the server's console, if it is enabled. Commands entered in the console do not require the `!admin` prefix.
|
||||
|
||||
## Categories
|
||||
|
||||
{%~ for category in categories %}
|
||||
- [`!admin {{ category.name }}`]({{ category.name }}/) {{ category.description }}
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue