@ -25,7 +25,14 @@ Clone the repo, build it with `cargo build --release` and call the binary
@@ -25,7 +25,14 @@ Clone the repo, build it with `cargo build --release` and call the binary
##### Using Docker
Build the docker image and run it with docker or docker-compose. [Read more](docker/README.md)
Pull and run the docker image with
``` bash
docker pull matrixconduit/matrix-conduit:latest
docker run -d matrixconduit/matrix-conduit:latest -p 8448:8000 -v db:/srv/conduit/.local/share/conduit
```
Or build and run it with docker or docker-compose. [Read more](docker/README.md)
which also will tag the resulting image as `conduit_homeserver:latest`.
which also will tag the resulting image as `matrixconduit/matrix-conduit:latest`.
**Note:** it ommits the two optional `build-arg`s.
@ -40,7 +40,7 @@ which also will tag the resulting image as `conduit_homeserver:latest`.
@@ -40,7 +40,7 @@ which also will tag the resulting image as `conduit_homeserver:latest`.
After building the image you can simply run it with
``` bash
docker run conduit_homeserver:latest -p 8448:8000 -v db:/srv/conduit/.local/share/conduit -e ROCKET_SERVER_NAME="localhost:8000"
docker run -d matrixconduit/matrix-conduit:latest -p 8448:8000 -v db:/srv/conduit/.local/share/conduit -e ROCKET_SERVER_NAME="localhost:8000"
```
For detached mode, you also need to use the `-d` flag. You can pass in more env vars as are shown here, for an overview of possible values, you can take a look at the `docker-compose.yml` file.
@ -49,7 +49,7 @@ If you just want to test Conduit for a short time, you can use the `--rm` flag,
@@ -49,7 +49,7 @@ If you just want to test Conduit for a short time, you can use the `--rm` flag,
## Docker-compose
If the docker command is not for you or your setup, you can also use one of the provided `docker-compose` files. Depending on your proxy setup, use the `docker-compose.traefik.yml` including `docker-compose.override.traefik.yml` or the normal `docker-compose.yml` for every other reverse proxy.
If the docker command is not for you or your setup, you can also use one of the provided `docker-compose` files. Depending on your proxy setup, use the [`docker-compose.traefik.yml`](docker-compose.traefik.yml) including [`docker-compose.override.traefik.yml`](docker-compose.override.traefik.yml) or the normal [`docker-compose.yml`](../docker-compose.yml) for every other reverse proxy.
@ -17,6 +17,7 @@ Can invite users to invite-only rooms
@@ -17,6 +17,7 @@ Can invite users to invite-only rooms
Can list tags for a room
Can logout all devices
Can logout current device
Can re-join room if re-invited
Can read configuration endpoint
Can recv a device message using /sync
Can recv device messages until they are acknowledged
@ -37,6 +38,7 @@ Current state appears in timeline in private history with many messages before
@@ -37,6 +38,7 @@ Current state appears in timeline in private history with many messages before
Deleted tags appear in an incremental v2 /sync
Deleting a non-existent alias should return a 404
Device messages wake up /sync
Device messages with the same txn_id are deduplicated
Events come down the correct room
GET /device/{deviceId}
GET /device/{deviceId} gives a 404 for unknown devices
@ -87,6 +89,7 @@ POST /rooms/:room_id/join can join a room
@@ -87,6 +89,7 @@ POST /rooms/:room_id/join can join a room
POST /rooms/:room_id/leave can leave a room
POST /rooms/:room_id/state/m.room.name sets name
POST /rooms/:room_id/state/m.room.topic sets topic
POST /rooms/:room_id/upgrade can upgrade a room version
POSTed media can be thumbnailed
PUT /device/{deviceId} gives a 404 for unknown devices
PUT /device/{deviceId} updates device fields
@ -113,7 +116,6 @@ Typing events appear in incremental sync
@@ -113,7 +116,6 @@ Typing events appear in incremental sync
Typing events appear in initial sync
Uninvited users cannot join the room
User appears in user directory
User directory correctly update on display name change
User in dir while user still shares private rooms
User in shared private room does appear in user directory
User is offline if they set_presence=offline in their sync
Timo Kösters
5 years ago