diff --git a/docs/deploying/docker-compose.for-traefik.yml b/docs/deploying/docker-compose.for-traefik.yml index ae93d52fa71a7618eaa9b6036d213ab1dde3d718..b43164269b1de0de637aacae19034893f0a243b9 100644 --- a/docs/deploying/docker-compose.for-traefik.yml +++ b/docs/deploying/docker-compose.for-traefik.yml @@ -14,7 +14,6 @@ services: environment: CONDUWUIT_SERVER_NAME: your.server.name.example # EDIT THIS CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit - CONDUWUIT_DATABASE_BACKEND: rocksdb CONDUWUIT_PORT: 6167 # should match the loadbalancer traefik label CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB CONDUWUIT_ALLOW_REGISTRATION: 'true' diff --git a/docs/deploying/docker-compose.with-caddy.yml b/docs/deploying/docker-compose.with-caddy.yml index 369242126a881a48e070baece9f139bb4d14df97..c080293f05879ddfd7a901bcdf23ad07f737a1ad 100644 --- a/docs/deploying/docker-compose.with-caddy.yml +++ b/docs/deploying/docker-compose.with-caddy.yml @@ -30,7 +30,6 @@ services: environment: CONDUWUIT_SERVER_NAME: example.com # EDIT THIS CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit - CONDUWUIT_DATABASE_BACKEND: rocksdb CONDUWUIT_PORT: 6167 CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB CONDUWUIT_ALLOW_REGISTRATION: 'true' diff --git a/docs/deploying/docker-compose.yml b/docs/deploying/docker-compose.yml index 26145c5ae0372ad5040c6d4e24f6ebaed9532bd7..3b7d84ed1f9d587025fe6e9e0892b6e313adb350 100644 --- a/docs/deploying/docker-compose.yml +++ b/docs/deploying/docker-compose.yml @@ -14,7 +14,6 @@ services: environment: CONDUWUIT_SERVER_NAME: your.server.name # EDIT THIS CONDUWUIT_DATABASE_PATH: /var/lib/conduwuit - CONDUWUIT_DATABASE_BACKEND: rocksdb CONDUWUIT_PORT: 6167 CONDUWUIT_MAX_REQUEST_SIZE: 20000000 # in bytes, ~20 MB CONDUWUIT_ALLOW_REGISTRATION: 'true' diff --git a/docs/deploying/docker.md b/docs/deploying/docker.md index 7b8fd1a2cc47cb8c6587f42e9f88491ce5cd464d..e9c49c71663a997ef86a5403e49158a13d36774c 100644 --- a/docs/deploying/docker.md +++ b/docs/deploying/docker.md @@ -40,7 +40,6 @@ ### Run docker run -d -p 8448:6167 \ -v db:/var/lib/conduwuit/ \ -e CONDUWUIT_SERVER_NAME="your.server.name" \ - -e CONDUWUIT_DATABASE_BACKEND="rocksdb" \ -e CONDUWUIT_ALLOW_REGISTRATION=false \ --name conduit $LINK ``` diff --git a/docs/deploying/generic.md b/docs/deploying/generic.md index 31dc18456ab866c12a10ae8e399f134b3e202aa3..6fe9709b3c9f9a64f65e011e3fbd8fbb12445b49 100644 --- a/docs/deploying/generic.md +++ b/docs/deploying/generic.md @@ -42,6 +42,9 @@ ## Migrating from Conduit this will **NOT** work on conduwuit and you must configure delegation manually. This is not a mistake and no support for this feature will be added. +If you are using SQLite, you **MUST** migrate to RocksDB. You can use this +tool to migrate from SQLite to RocksDB: <https://github.com/ShadowJonathan/conduit_toolbox/> + See the `[global.well_known]` config section, or configure your web server appropriately to send the delegation responses. @@ -137,11 +140,20 @@ ## Setting up the Reverse Proxy You can optionally reverse proxy the following individual routes: - `/.well-known/matrix/client` and `/.well-known/matrix/server` if using -conduwuit to perform delegation +conduwuit to perform delegation (see the `[global.well_known]` config section) - `/.well-known/matrix/support` if using conduwuit to send the homeserver admin contact and support page (formerly known as MSC1929) - `/` if you would like to see `hewwo from conduwuit woof!` at the root +See the following spec pages for more details on these files: +- [`/.well-known/matrix/server`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixserver) +- [`/.well-known/matrix/client`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient) +- [`/.well-known/matrix/support`](https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixsupport) + +Examples of delegation: +- <https://puppygock.gay/.well-known/matrix/server> +- <https://puppygock.gay/.well-known/matrix/client> + ### Caddy Create `/etc/caddy/conf.d/conduwuit_caddyfile` and enter this (substitute for diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index c1499f3a1312d9ef053a153aa9d1310d65991321..74e19de762bcb2dafb6405b47795610ba5d67245 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -47,10 +47,11 @@ #### Direct IO Some filesystems may not like RocksDB using [Direct IO](https://github.com/facebook/rocksdb/wiki/Direct-IO). Direct IO is for -non-buffered I/O which improves conduwuit performance, but at least FUSE is a -filesystem potentially known to not like this. See the [example -config](configuration/examples.md) for disabling it if needed. Issues from -Direct IO on unsupported filesystems are usually shown as startup errors. +non-buffered I/O which improves conduwuit performance and reduces system CPU +usage, but at least FUSE and possibly ZFS are filesystems potentially known +to not like this. See the [example config](configuration/examples.md) for +disabling it if needed. Issues from Direct IO on unsupported filesystems are +usually shown as startup errors. #### Database corruption