Просмотр исходного кода

Merge pull request #4094 from luixxiul/fix

Update docs related to installation: minor edits
pull/4095/head
Slavi Pantaleev 1 год назад
committed by GitHub
Родитель
Сommit
b66aa0624f
Не найден GPG ключ соответствующий данной подписи Идентификатор GPG ключа: B5690EEEBB952194
2 измененных файлов: 9 добавлений и 7 удалений
  1. +4
    -2
      docs/installing.md
  2. +5
    -5
      docs/quick-start.md

+ 4
- 2
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**.



+ 5
- 5
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.



Загрузка…
Отмена
Сохранить