mirror of
https://forgejo.ellis.link/continuwuation/continuwuity.git
synced 2026-05-26 20:49:55 +00:00
docs(docker): Detail how to access the server's console
This commit is contained in:
@@ -243,8 +243,26 @@ For information on building your own Continuwuity Docker images, see the
|
||||
[Building Docker Images](../development/index.mdx#building-docker-images)
|
||||
section in the development documentation.
|
||||
|
||||
### Accessing the Server's Console
|
||||
|
||||
In order to enable access the server's console to [send admin commands](../reference/admin/index.md) from the CLI, the docker deployment will need to be made interactive and allocate a psuedo-tty. For deployments via Docker Compose, this means adding `stdin_open: true` and `tty: true` to the containers decleration:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
homserver:
|
||||
stdin_open: true
|
||||
tty: true
|
||||
<snip>
|
||||
```
|
||||
|
||||
If you choose to deploy via `docker run`, then add the flags `-i`/`--interactive` and `-t`/`--tty` to the command.
|
||||
|
||||
From there you can access the server's console by running `docker attach <container-name>`, which will show the server's prompt `uwu> `. To exit `docker attach` press ctrl+p then ctrl+q.
|
||||
|
||||
## Next steps
|
||||
|
||||
## Voice communication
|
||||
|
||||
- For smooth federation, set up a caching resolver according to the [**DNS tuning guide**](../advanced/dns.mdx) (recommended)
|
||||
- To set up Audio/Video communication, see the [**Calls**](../calls.mdx) page.
|
||||
- If you want to set up an appservice, take a look at the [**Appservice
|
||||
|
||||
@@ -7,7 +7,7 @@ Admin commands allow server administrators to manage the server from within thei
|
||||
|
||||
* 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`.
|
||||
* 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. If continuwuity is deployed via docker be sure to set the appropriate options detailed in [the docker deployment guide](../../deploying/docker.mdx#accessing-the-servers-console) to enable access to the server's console.
|
||||
|
||||
## Categories
|
||||
|
||||
|
||||
Reference in New Issue
Block a user