From 66506038146f2c7d71ed8dc584f261c7668b26d2 Mon Sep 17 00:00:00 2001 From: Eneko Nieto Date: Sun, 17 Apr 2022 15:47:13 +0200 Subject: [PATCH] doc: moved docker instructions to main README --- README.md | 19 +++++++++++++++++++ docker/README.md | 16 ---------------- src/main/kotlin/eu/fosil/okupamicoche/Main.kt | 2 +- .../TravelEventContentSerializerMappings.kt | 2 +- .../okupamicoche/matrix/matrixApiClient.kt | 2 +- 5 files changed, 22 insertions(+), 19 deletions(-) delete mode 100644 docker/README.md diff --git a/README.md b/README.md index 63581ee..c00cd06 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,28 @@ Matrix Application Service for Okupa mi coche +## Setup + +1. Install Docker in local machine +2. Add following line to /etc/hosts + +``` +127.0.0.1 okupamicoche-synapse +``` + +3. Go to `docker/synapse` and run `docker-compose up` + +## Run + +1. Start synapse: `docker restart okupamicoche-synapse` +2. Run app service: `./gradlew run` + ## Launch Element with dev profile + 1. Copy `docker/element/config.json` to `~/.config/Element-omc-dev/config.json`. 2. Launch new Element instance with `element-desktop --profile omc-dev`. 3. Send `/devtools` to any Element room. Enable `Developer mode` and `Show hidden events in timeline`. +Step 1 and 3 are only required in first run. + - Homeserver: `http://okupamicoche-synapse:8008` diff --git a/docker/README.md b/docker/README.md deleted file mode 100644 index 29bf3da..0000000 --- a/docker/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# Okupa mi coche - Docker containers for the backend -Guide for setting up a local development environment for the backend. - -## Setup -1. Install Docker in local machine -2. Add following line to /etc/hosts -``` -127.0.0.1 okupamicoche-synapse -``` -3. First run: `docker-compose up` - -## Run -`docker start okupamicoche-synapse` - -## Inspect container -`docker exec -t -i okupamicoche-synapse /bin/bash` diff --git a/src/main/kotlin/eu/fosil/okupamicoche/Main.kt b/src/main/kotlin/eu/fosil/okupamicoche/Main.kt index 08cf0e8..af8f124 100644 --- a/src/main/kotlin/eu/fosil/okupamicoche/Main.kt +++ b/src/main/kotlin/eu/fosil/okupamicoche/Main.kt @@ -24,7 +24,7 @@ suspend fun main() { matrixApplicationServiceApiServer( hsToken = config.tokens.homeserver, applicationServiceApiServerHandler = createAppService(matrixApiClient), - customMappings = TravelEventContentSerializerMappings() + customMappings = TravelEventContentSerializerMappings ) }.start(wait = true) diff --git a/src/main/kotlin/eu/fosil/okupamicoche/matrix/event/TravelEventContentSerializerMappings.kt b/src/main/kotlin/eu/fosil/okupamicoche/matrix/event/TravelEventContentSerializerMappings.kt index 7559981..2bb3d7b 100644 --- a/src/main/kotlin/eu/fosil/okupamicoche/matrix/event/TravelEventContentSerializerMappings.kt +++ b/src/main/kotlin/eu/fosil/okupamicoche/matrix/event/TravelEventContentSerializerMappings.kt @@ -5,7 +5,7 @@ import net.folivo.trixnity.core.model.events.StateEventContent import net.folivo.trixnity.core.serialization.events.BaseEventContentSerializerMappings import net.folivo.trixnity.core.serialization.events.EventContentSerializerMapping -class TravelEventContentSerializerMappings : BaseEventContentSerializerMappings() { +object TravelEventContentSerializerMappings : BaseEventContentSerializerMappings() { override val message: Set> = setOf( EventContentSerializerMapping.of(TRAVEL_CREATED_MESSAGE_EVENT_TYPE) ) diff --git a/src/main/kotlin/eu/fosil/okupamicoche/matrix/matrixApiClient.kt b/src/main/kotlin/eu/fosil/okupamicoche/matrix/matrixApiClient.kt index 337d0ff..54a2aed 100644 --- a/src/main/kotlin/eu/fosil/okupamicoche/matrix/matrixApiClient.kt +++ b/src/main/kotlin/eu/fosil/okupamicoche/matrix/matrixApiClient.kt @@ -19,7 +19,7 @@ val matrixApiClient = if (config == null) null else MatrixClientServerApiClient( (if (config.homeserver.secure) "https" else "http") + "://${config.homeserver.host}:${config.homeserver.port}" ), - eventContentSerializerMappings = createEventContentSerializerMappings(TravelEventContentSerializerMappings()) + eventContentSerializerMappings = createEventContentSerializerMappings(TravelEventContentSerializerMappings) ).apply { accessToken.value = config.tokens.appService } object MatrixApiClient {