From c1eae5fc00cdced01ee54a73c403f99fbb662533 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 23 Feb 2025 19:25:04 +0900 Subject: [PATCH 1/3] Update docs/installing.md: minor edits Signed-off-by: Suguru Hirahara --- docs/installing.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/installing.md b/docs/installing.md index e0bf44404..181dc3a1b 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -134,9 +134,11 @@ After configuring the playbook, run the command below: ansible-playbook -i inventory/hosts setup.yml --tags=install-matrix-static-files,start ``` +**If an error is not returned, the installation has completed and the services have been started successfully**🎉 + ## Things to do next -After finilizing the installation, you can: +After completing the installation, you can: - [check if services work](maintenance-and-troubleshooting.md#how-to-check-if-services-work) - or [set up additional services](configuring-playbook.md#other-configuration-options) (bridges to other chat networks, bots, etc.) @@ -147,7 +149,7 @@ After finilizing the installation, you can: * or come say Hi in our support room — [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com). You might learn something or get to help someone else new to Matrix hosting. - or help make this playbook better by contributing (code, documentation, or [coffee/beer](https://liberapay.com/s.pantaleev/donate)) -### Maintaining your setup in the future +### ⚠️Keep the playbook and services up-to-date While this playbook helps you to set up Matrix services and maintain them, it will **not** automatically run the maintenance task for you. You will need to update the playbook and re-run it **manually**. From b4bcac7e481fb9936788a64bd1b90f568bdc3614 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 23 Feb 2025 19:25:12 +0900 Subject: [PATCH 2/3] Update docs/quick-start.md: minor edits - Reduce width of the table for DNS configuration Signed-off-by: Suguru Hirahara --- docs/quick-start.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index fbb579f61..70e4de3f3 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -43,10 +43,10 @@ After installing and configuring prerequisites, you will need to **configure DNS To configure Matrix services in the default settings, go to your DNS service provider, and adjust DNS records as below. -| Type | Host | Priority | Weight | Port | Target | -| ----- | ---------------------------- | -------- | ------ | ---- | ---------------------| -| A | `matrix` | - | - | - | `matrix-server-IP` | -| CNAME | `element` | - | - | - | `matrix.example.com` | +| Type | Host | Priority | Weight | Port | Target | +| ----- | ----------| -------- | ------ | ---- | ---------------------| +| A | `matrix` | - | - | - | `matrix-server-IP` | +| CNAME | `element` | - | - | - | `matrix.example.com` | As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IP address (DNS `A` record or `CNAME` record is fine). @@ -191,7 +191,7 @@ Finally, let's make sure that you can log in to the created account with the spe You should be able to log in to it with your own [Element Web](configuring-playbook-client-element-web.md) client which you have set up at `element.example.com` by running the playbook. Open the URL (`https://element.example.com`) in a web browser and enter your credentials to log in. -**If you successfully logged in to your account, installing and configuring is complete**🎉 +**If you successfully logged in to your account, the installation and configuration have completed successfully**🎉 Come say Hi👋 in our support room — [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com). You might learn something or get to help someone else new to Matrix hosting. From cca3b06cf09206e681ad663360929a5f78c1b2f7 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Sun, 23 Feb 2025 12:32:32 +0200 Subject: [PATCH 3/3] =?UTF-8?q?Add=20space=20after=20=E2=9A=A0=EF=B8=8F=20?= =?UTF-8?q?on=20installing.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/installing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installing.md b/docs/installing.md index 181dc3a1b..34e4548b5 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -149,7 +149,7 @@ After completing the installation, you can: * or come say Hi in our support room — [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com). You might learn something or get to help someone else new to Matrix hosting. - or help make this playbook better by contributing (code, documentation, or [coffee/beer](https://liberapay.com/s.pantaleev/donate)) -### ⚠️Keep the playbook and services up-to-date +### ⚠️ Keep the playbook and services up-to-date While this playbook helps you to set up Matrix services and maintain them, it will **not** automatically run the maintenance task for you. You will need to update the playbook and re-run it **manually**.