|
2 years ago | |
---|---|---|
.. | ||
README.md | 3 years ago | |
ci-binaries-packaging.Dockerfile | 2 years ago | |
docker-compose.for-traefik.yml | 3 years ago | |
docker-compose.override.yml | 3 years ago | |
docker-compose.with-traefik.yml | 3 years ago | |
healthcheck.sh | 3 years ago |
README.md
Deploy using Docker
Note: To run and use Conduit you should probably use it with a Domain or Subdomain behind a reverse proxy (like Nginx, Traefik, Apache, ...) with a Lets Encrypt certificate.
Docker
Build & Dockerfile
The Dockerfile provided by Conduit has two stages, each of which creates an image.
- Builder: Builds the binary from local context or by cloning a git revision from the official repository.
- Runner: Copies the built binary from Builder and sets up the runtime environment, like creating a volume to persist the database and applying the correct permissions.
To build the image you can use the following command
docker build --tag matrixconduit/matrix-conduit:latest .
which also will tag the resulting image as matrixconduit/matrix-conduit:latest
.
Run
After building the image you can simply run it with
docker run -d -p 8448:6167 \
-v db:/var/lib/matrix-conduit/ \
-e CONDUIT_SERVER_NAME="your.server.name" \
-e CONDUIT_DATABASE_BACKEND="rocksdb" \
-e CONDUIT_ALLOW_REGISTRATION=true \
-e CONDUIT_ALLOW_FEDERATION=true \
-e CONDUIT_MAX_REQUEST_SIZE="20_000_000" \
-e CONDUIT_TRUSTED_SERVERS="[\"matrix.org\"]" \
-e CONDUIT_MAX_CONCURRENT_REQUESTS="100" \
-e CONDUIT_LOG="info,rocket=off,_=off,sled=off" \
--name conduit matrixconduit/matrix-conduit:latest
or you can skip the build step and pull the image from one of the following registries:
Registry | Image | Size |
---|---|---|
Docker Hub | matrixconduit/matrix-conduit:latest | |
GitLab Registry | registry.gitlab.com/famedly/conduit/matrix-conduit:latest |
The -d
flag lets the container run in detached mode. You now need to supply a conduit.toml
config file, an example can be found here.
You can pass in different env vars to change config values on the fly. You can even configure Conduit completely by using env vars, but for that you need
to pass -e CONDUIT_CONFIG=""
into your container. For an overview of possible values, please take a look at the docker-compose.yml
file.
If you just want to test Conduit for a short time, you can use the --rm
flag, which will clean up everything related to your container after you stop it.
Docker-compose
If the docker run
command is not for you or your setup, you can also use one of the provided docker-compose
files.
Depending on your proxy setup, you can use one of the following files;
- If you already have a
traefik
instance set up, usedocker-compose.for-traefik.yml
- If you don't have a
traefik
instance set up (or any other reverse proxy), usedocker-compose.with-traefik.yml
- For any other reverse proxy, use
docker-compose.yml
When picking the traefik-related compose file, rename it so it matches docker-compose.yml
, and
rename the override file to docker-compose.override.yml
. Edit the latter with the values you want
for your server.
Additional info about deploying Conduit can be found here.
Build
To build the Conduit image with docker-compose, you first need to open and modify the docker-compose.yml
file. There you need to comment the image:
option and uncomment the build:
option. Then call docker-compose with:
docker-compose up
This will also start the container right afterwards, so if want it to run in detached mode, you also should use the -d
flag.
Run
If you already have built the image or want to use one from the registries, you can just start the container and everything else in the compose file in detached mode with:
docker-compose up -d
Note: Don't forget to modify and adjust the compose file to your needs.
Use Traefik as Proxy
As a container user, you probably know about Traefik. It is a easy to use reverse proxy for making
containerized app and services available through the web. With the two provided files,
docker-compose.for-traefik.yml
(or
docker-compose.with-traefik.yml
) and
docker-compose.override.yml
, it is equally easy to deploy
and use Conduit, with a little caveat. If you already took a look at the files, then you should have
seen the well-known
service, and that is the little caveat. Traefik is simply a proxy and
loadbalancer and is not able to serve any kind of content, but for Conduit to federate, we need to
either expose ports 443
and 8448
or serve two endpoints .well-known/matrix/client
and
.well-known/matrix/server
.
With the service well-known
we use a single nginx
container that will serve those two files.
So...step by step:
-
Copy
docker-compose.traefik.yml
anddocker-compose.override.traefik.yml
from the repository and remove.traefik
from the filenames. -
Open both files and modify/adjust them to your needs. Meaning, change the
CONDUIT_SERVER_NAME
and the volume host mappings according to your needs. -
Create the
conduit.toml
config file, an example can be found here, or setCONDUIT_CONFIG=""
and configure Conduit per env vars. -
Uncomment the
element-web
service if you want to host your own Element Web Client and create aelement_config.json
. -
Create the files needed by the
well-known
service.-
./nginx/matrix.conf
(relative to the compose file, you can change this, but then also need to change the volume mapping)server { server_name <SUBDOMAIN>.<DOMAIN>; listen 80 default_server; location /.well-known/matrix/server { return 200 '{"m.server": "<SUBDOMAIN>.<DOMAIN>:443"}'; add_header Content-Type application/json; } location /.well-known/matrix/client { return 200 '{"m.homeserver": {"base_url": "https://<SUBDOMAIN>.<DOMAIN>"}}'; add_header Content-Type application/json; add_header "Access-Control-Allow-Origin" *; } location / { return 404; } }
-
-
Run
docker-compose up -d
-
Connect to your homeserver with your preferred client and create a user. You should do this immediately after starting Conduit, because the first created user is the admin.