aboutsummaryrefslogtreecommitdiff
path: root/op_guide/update_matrix/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'op_guide/update_matrix/README.md')
-rw-r--r--op_guide/update_matrix/README.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/op_guide/update_matrix/README.md b/op_guide/update_matrix/README.md
index 7df588f..0862be0 100644
--- a/op_guide/update_matrix/README.md
+++ b/op_guide/update_matrix/README.md
@@ -3,22 +3,26 @@ How to update Matrix?
## 1. Build the new containers
-It starts with this file: `app/build/docker-compose.yml`.
Often, I update Riot Web and Synapse at the same time.
-In the file, find the `riot` and `synapse` entries.
-The only thing you need to do is to update the `VERSION` argument.
-This argument is then used to template the Dockerfile.
-The `VERSION` value should match a github release, the link to the corresponding release page is put as a comment next to the variable in the compose file.
-Next, we put tags on our images.
-You need to increment it, for example: `superboum/amd64_riotweb:v17` will become `superboum/amd64_riotweb:v18`.
-We use the docker hub to store our images, if you are not `superboum` you must change the name with your handle, eg. `john/amd64_riotweb:v18`.
-So, from now we expact you have:
- - changed the `VERSION` value and `image` name/tag of `riot`
- - changed the `VERSION` value and `image` name/tag of `synapse`
+* Open `app/docker-compose.yml` and locate `riot` (the Element Web service) and `synapse` (the Matrix Synapse server). There are two things you need to do for each service:
-You can now simply build and push the new images:
+ * Set the `VERSION` argument to the target service version (e.g. `1.26.0` for Synapse). This argument is then used to template the Dockerfile.
+
+ The `VERSION` value should match a github release, the link to the corresponding release page is put as a comment next to the variable in the compose file;
+
+ * Tag the image with a new incremented version tag. For example: `superboum/amd64_riotweb:v17` will become `superboum/amd64_riotweb:v18`.
+
+ We use the docker hub to store our images. So, if you are not `superboum` you must change the name with your own handle, eg. `john/amd64_riotweb:v18`. This requires that you registered an account (named `john`) on https://hub.docker.com.
+
+
+So, from now we expect you have:
+
+* changed the `VERSION` value and `image` name/tag of `riot`
+* changed the `VERSION` value and `image` name/tag of `synapse`
+
+From the `/app` folder, you can now simply build and push the new images:
```bash
docker-compose build riot synapse