diff --git a/docs/deploying/docker.mdx b/docs/deploying/docker.mdx index ec416309f..832e9581a 100644 --- a/docs/deploying/docker.mdx +++ b/docs/deploying/docker.mdx @@ -245,23 +245,25 @@ 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: +Before you can access the server's console and [send admin commands](../reference/admin/index.md) from the CLI, you will need to make the container interactive and allocate a psuedo-tty. + +For Docker Compose deployments this means adding `stdin_open: true` and `tty: true` to the container's decleration: ```yaml services: homserver: stdin_open: true tty: true - + # ... ``` -If you choose to deploy via `docker run`, then add the flags `-i`/`--interactive` and `-t`/`--tty` to the command. +If you choose to deploy via `docker run`, add the flags `-i`/`--interactive` and `-t`/`--tty` to the command. From there you can access the server's console by running `docker attach `, which will show the server's prompt `uwu> `. To exit `docker attach` press ctrl+p then ctrl+q. -## Next steps +Note that using `CTRL+c` within `docker attach`'s context will forward the signal to the server, stopping it. To exit `docker attach` press `CTRL+p` then `CTRL+q`. See [Docker's reference](https://docs.docker.com/reference/cli/docker/container/attach/) for more information. -## Voice communication +## Next steps - 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. diff --git a/docs/reference/admin/index.md b/docs/reference/admin/index.md index 060a96d22..8d52648c9 100644 --- a/docs/reference/admin/index.md +++ b/docs/reference/admin/index.md @@ -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. 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. +* 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