mirror of
https://forgejo.ellis.link/continuwuation/continuwuity.git
synced 2026-05-26 20:49:55 +00:00
docs(docker): Revert to mounting /etc/resolv.conf as configs: won't work
* Fix wording to make mounting resolv.conf more imperative * Linting and other changes
This commit is contained in:
+12
-14
@@ -88,7 +88,7 @@ Get a working Continuwuity server with an admin user in four steps:
|
||||
In order to use your new homeserver, you need to create its
|
||||
first user account.
|
||||
Open your Matrix client of choice and register an account
|
||||
on example.com using registration token x5keUZ811RqvLsNa .
|
||||
on example.com using registration token x5keUZ811RqvLsNa .
|
||||
Pick your own username and password!
|
||||
```
|
||||
|
||||
@@ -113,24 +113,22 @@ See the [reference configuration](../reference/config) page for all config optio
|
||||
These examples include reverse proxy configurations for Matrix federation, which will route your Matrix domain (and optionally .well-known paths) to Continuwuity.
|
||||
|
||||
:::note Docker DNS Performance
|
||||
Docker's default DNS resolver are [known to cause issues](../troubleshooting#dns-issues) for Matrix federation such as very slow federation or DNS timeouts. As a workaround, we will mount a custom `/etc/resolv.conf` config file into the Continuwuity service, in order to bypass Docker and use a more performant resolver.
|
||||
Docker's default DNS resolver are known to [cause timeout issues](../troubleshooting#dns-issues) for Matrix federation. To bypass it and use a more performant resolver, mount a custom `/etc/resolv.conf` config file into the Continuwuity container.
|
||||
|
||||
```yaml title='docker-compose.yml'
|
||||
services:
|
||||
homeserver:
|
||||
# ...
|
||||
configs:
|
||||
- source: continuwuity-resolv.conf
|
||||
target: /etc/resolv.conf
|
||||
|
||||
configs:
|
||||
continuwuity-resolv.conf:
|
||||
content: |
|
||||
nameserver 1.0.0.1
|
||||
nameserver 1.1.1.1
|
||||
volumes:
|
||||
- ./continuwuity-resolv.conf:/etc/resolv.conf
|
||||
```
|
||||
|
||||
It is strongly recommended to consult the [**DNS tuning guide**](../advanced/dns) for full solutions to this issue.
|
||||
```txt title='continuwuity-resolv.conf'
|
||||
nameserver 1.0.0.1
|
||||
nameserver 1.1.1.1
|
||||
```
|
||||
|
||||
Consult the [**DNS tuning guide (recommended)**](../advanced/dns) for full solutions to this issue.
|
||||
:::
|
||||
|
||||
#### Caddy (using Caddyfile)
|
||||
@@ -224,7 +222,7 @@ You will then need to point your reverse proxy towards Continuwuity at `127.0.0.
|
||||
In order to use your new homeserver, you need to create its
|
||||
first user account.
|
||||
Open your Matrix client of choice and register an account
|
||||
on example.com using registration token x5keUZ811RqvLsNa .
|
||||
on example.com using registration token x5keUZ811RqvLsNa .
|
||||
Pick your own username and password!
|
||||
```
|
||||
|
||||
@@ -241,4 +239,4 @@ section in the development documentation.
|
||||
## Next steps
|
||||
|
||||
- For smooth federation, set up a caching resolver according to the [DNS tuning guide](../advanced/dns)
|
||||
- To set up Audio/Video communication, see the [Calls](../calls.mdx) page.
|
||||
- To set up Audio/Video communication, see the [Calls](../calls.mdx) page.
|
||||
|
||||
@@ -7,6 +7,7 @@ services:
|
||||
command: /sbin/conduwuit
|
||||
volumes:
|
||||
- db:/var/lib/continuwuity
|
||||
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
|
||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||
networks:
|
||||
- proxy
|
||||
@@ -34,14 +35,6 @@ services:
|
||||
client=https://matrix.example.com,
|
||||
server=matrix.example.com:443
|
||||
}
|
||||
#cpuset: "0-4" # Uncomment to limit to specific CPU cores
|
||||
ulimits: # Continuwuity uses quite a few file descriptors, and on some systems it defaults to 1024, so you can tell docker to increase it
|
||||
nofile:
|
||||
soft: 1048567
|
||||
hard: 1048567
|
||||
configs: # using custom resolver instead of Docker's
|
||||
- source: continuwuity-resolv.conf
|
||||
target: /etc/resolv.conf
|
||||
|
||||
volumes:
|
||||
db:
|
||||
@@ -51,9 +44,3 @@ networks:
|
||||
# name, don't forget to change it here and in the docker-compose.override.yml
|
||||
proxy:
|
||||
external: true
|
||||
|
||||
configs:
|
||||
continuwuity-resolv.conf:
|
||||
content: |
|
||||
nameserver 1.0.0.1
|
||||
nameserver 1.1.1.1
|
||||
@@ -24,6 +24,7 @@ services:
|
||||
command: /sbin/conduwuit
|
||||
volumes:
|
||||
- db:/var/lib/continuwuity
|
||||
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
|
||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||
environment:
|
||||
CONTINUWUITY_SERVER_NAME: example.com # EDIT THIS
|
||||
@@ -40,18 +41,8 @@ services:
|
||||
labels:
|
||||
caddy: matrix.example.com
|
||||
caddy.reverse_proxy: "{{upstreams 8008}}"
|
||||
configs: # using custom resolver instead of Docker's
|
||||
- source: continuwuity-resolv.conf
|
||||
target: /etc/resolv.conf
|
||||
volumes:
|
||||
db:
|
||||
|
||||
networks:
|
||||
caddy:
|
||||
|
||||
configs:
|
||||
continuwuity-resolv.conf:
|
||||
content: |
|
||||
nameserver 1.0.0.1
|
||||
nameserver 1.1.1.1
|
||||
|
||||
|
||||
@@ -13,13 +13,14 @@ services:
|
||||
configs:
|
||||
- source: Caddyfile
|
||||
target: /etc/caddy/Caddyfile
|
||||
|
||||
|
||||
homeserver:
|
||||
image: forgejo.ellis.link/continuwuation/continuwuity:latest
|
||||
restart: unless-stopped
|
||||
command: /sbin/conduwuit
|
||||
volumes:
|
||||
- db:/var/lib/continuwuity
|
||||
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
|
||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||
environment:
|
||||
CONTINUWUITY_SERVER_NAME: example.com
|
||||
@@ -29,9 +30,6 @@ services:
|
||||
#CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above
|
||||
networks:
|
||||
- caddy
|
||||
configs: # using custom resolvers instead of Docker's
|
||||
- source: continuwuity-resolv.conf
|
||||
target: /etc/resolv.conf
|
||||
|
||||
networks:
|
||||
caddy:
|
||||
@@ -45,8 +43,3 @@ configs:
|
||||
https://example.com, https://example.com:8448 {
|
||||
reverse_proxy http://homeserver:8008
|
||||
}
|
||||
|
||||
continuwuity-resolv.conf:
|
||||
content: |
|
||||
nameserver 1.0.0.1
|
||||
nameserver 1.1.1.1
|
||||
|
||||
@@ -7,6 +7,7 @@ services:
|
||||
command: /sbin/conduwuit
|
||||
volumes:
|
||||
- db:/var/lib/continuwuity
|
||||
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
|
||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||
networks:
|
||||
- proxy
|
||||
@@ -31,14 +32,6 @@ services:
|
||||
client=https://matrix.example.com,
|
||||
server=matrix.example.com:443
|
||||
}
|
||||
#cpuset: "0-4" # Uncomment to limit to specific CPU cores
|
||||
ulimits: # Continuwuity uses quite a few file descriptors, and on some systems it defaults to 1024, so you can tell docker to increase it
|
||||
nofile:
|
||||
soft: 1048567
|
||||
hard: 1048567
|
||||
configs: # using custom resolver instead of Docker's
|
||||
- source: continuwuity-resolv.conf
|
||||
target: /etc/resolv.conf
|
||||
|
||||
traefik:
|
||||
image: "traefik:latest"
|
||||
@@ -86,14 +79,8 @@ services:
|
||||
TRAEFIK_PROVIDERS_DOCKER_EXPOSEDBYDEFAULT: false
|
||||
|
||||
volumes:
|
||||
db:
|
||||
acme:
|
||||
db:
|
||||
acme:
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
|
||||
configs:
|
||||
continuwuity-resolv.conf:
|
||||
content: |
|
||||
nameserver 1.0.0.1
|
||||
nameserver 1.1.1.1
|
||||
proxy:
|
||||
|
||||
@@ -9,23 +9,14 @@ services:
|
||||
- 127.0.0.1:8008:8008
|
||||
volumes:
|
||||
- db:/var/lib/continuwuity
|
||||
- ./continuwuity-resolv.conf:/etc/resolv.conf # use custom resolvers rather than Docker's
|
||||
#- ./continuwuity.toml:/etc/continuwuity.toml
|
||||
environment:
|
||||
CONTINUWUITY_SERVER_NAME: example.com # EDIT THIS
|
||||
CONTINUWUITY_DATABASE_PATH: /var/lib/continuwuity
|
||||
CONTINUWUITY_ADDRESS: 0.0.0.0
|
||||
CONTINUWUITY_PORT: 8008
|
||||
CONTINUWUITY_PORT: 8008
|
||||
#CONTINUWUITY_CONFIG: '/etc/continuwuity.toml' # Uncomment if you mapped config toml above
|
||||
configs: # using custom resolver instead of Docker's
|
||||
- source: continuwuity-resolv.conf
|
||||
target: /etc/resolv.conf
|
||||
|
||||
|
||||
volumes:
|
||||
db:
|
||||
|
||||
configs:
|
||||
continuwuity-resolv.conf:
|
||||
content: |
|
||||
nameserver 1.0.0.1
|
||||
nameserver 1.1.1.1
|
||||
Reference in New Issue
Block a user