continuwuity/docs/reference/admin/index.md

Admin Command Reference

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. To enable this functionality when deployed via docker ensure the container was started with the interactive (-i/--interactive) and tty (-t/--tty) options for docker run, or add std_open: true and tty: true to the container's decleration within the docker-compose.yml file for docker-compose deployments. Commands can then be sent to the console through docker attach.

Categories

• !admin appservices: Commands for managing appservices
• !admin users: Commands for managing local users
• !admin token: Commands for managing registration tokens
• !admin rooms: Commands for managing rooms
• !admin federation: Commands for managing federation
• !admin server: Commands for managing the server
• !admin media: Commands for managing media
• !admin check: Commands for checking integrity
• !admin debug: Commands for debugging things
• !admin query: Low-level queries for database getters and iterators