MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-06-06 12:08:56 +02:00
Code Issues Releases Wiki Activity

Updated Useful console command examples (markdown)

Jason Volk 2020-08-24 01:06:32 -07:00
parent 15ea6f44e4
commit d412e8844a
1 changed files with 21 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
Useful-console-command-examples.md

@ -1,9 +1,26 @@
# Some random useful commands
The console right now lacks comprehensive help; here are some useful commands seen in the wild.
You can use the console (*CTRL-C*) or the *!control:SERVERNAME* room. Riot is super inconvenient for the latter, but *nheko* (for example) makes it convenient to edit the previous line.
# Administrative Console
Most of these commands are only interesting throughout the betatesting, like unscrewing room or server states, or examining what's going on.
There are several ways to interact with the console:
1. Administrators with local access can strike *CTRL-C* and interact with the command prompt. This is the same as otherwise raising SIGINT and interacting with the server using standard input and output, which is available to parent processes.
2. Administrators may join themselves to *!control:SERVERNAME* room (using terminal: `room join !control:servername @user:servername`).
> 👉 Note responses to commands are truncated to the 64 KiB Matrix event limit in this mode (but rarely an issue).
- Riot is inconvenient for this use case; suggest compact timeline layout mode.
- [nheko](https://github.com/Nheko-Reborn/nheko) makes it convenient to edit the previous line.
- The `!control` room in [gomuks](https://github.com/tulir/gomuks) looks and feels identical to the console and is the best choice.
3. Executing the server with the `-console` parameter will spawn the console immediately after startup. The server will still be running normally in the background.
4. Executing the server with the `-execute <command>` parameter will spawn the console immediately after startup and execute the command. Upon completion the console will exit; the server will still be running normally in the background.
> 👉 Only the next argument after `-execute` is the command. Refer to your shell's documentation for how to pass complex program options (hint: use quotes around commands with spaces).
> 👉 Use multiple `-execute` parameters for multiple commands.
❗ THE CONSOLE HAS COMPLETE CONTROL OF THE SERVER. CHANGES TO SERVER STATE AND CONFIGURATION THROUGH THE CONSOLE ARE EFFECTIVE IMMEDIATELY. ERRONEOUS VALUES MAY CAUSE UNEXPECTED BEHAVIOR RESULTING IN PROGRAM TERMINATION AND/OR LOSS OF DATA. ACCESS TO THE !CONTROL ROOM AND SERVER TERMINAL MUST REMAIN RESTRICTED AT ALL TIMES TO AUTHORIZED USERS ONLY.
> 👉 To learn more about a command, including the list of all sub-commands, use `help <command>`. We kindly request your contribution for missing help text.
## Table of Contents