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

Merge pull request #3775 from luixxiul/fix

Edit documentation pages for installation procedure
pull/3781/head
Slavi Pantaleev 1 год назад
committed by GitHub
Родитель
Сommit
bb827f44b1
Не найден GPG ключ соответствующий данной подписи Идентификатор GPG ключа: B5690EEEBB952194
5 измененных файлов: 11 добавлений и 17 удалений
  1. +2
    -2
      docs/configuring-dns.md
  2. +3
    -9
      docs/configuring-playbook.md
  3. +2
    -2
      docs/getting-the-playbook.md
  4. +2
    -2
      docs/installing.md
  5. +2
    -2
      docs/prerequisites.md

+ 2
- 2
docs/configuring-dns.md Просмотреть файл

@@ -1,6 +1,6 @@
# Configuring your DNS server

<sup>⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > Configuring your DNS server > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) </sup>
<sup>⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > Configuring your DNS server > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup>

To set up Matrix on your domain, you'd need to do some DNS configuration.

@@ -105,4 +105,4 @@ To make the [postmoogle](configuring-playbook-bridge-postmoogle.md) email bridge

---------------------------------------------

When you're done with the DNS configuration and ready to proceed, continue with [Getting the playbook](getting-the-playbook.md).
[▶️](getting-the-playbook.md) When you're done with the DNS configuration and ready to proceed, continue with [Getting the playbook](getting-the-playbook.md).

+ 3
- 9
docs/configuring-playbook.md Просмотреть файл

@@ -1,14 +1,8 @@
# Configuring the playbook

<sup>⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > Configuring the playbook > [Installing](installing.md) </sup>
<sup>⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > Configuring the playbook > [Installing](installing.md)</sup>

To configure the Ansible playbook, you need to have done the following things:

- have a server where Matrix services will run
- [configured your DNS records](configuring-dns.md)
- [retrieved the playbook's source code](getting-the-playbook.md) to your computer

You can then follow these steps inside the playbook directory:
If you've configured your DNS records and retrieved the playbook's source code to your computer, you can start configuring the playbook. To do so, follow these steps inside the playbook directory:

1. create a directory to hold your configuration (`mkdir -p inventory/host_vars/matrix.example.com` where `example.com` is your "base domain")

@@ -28,7 +22,7 @@ For a basic Matrix installation, that's all you need.

For a more custom setup, see the [Other configuration options](#other-configuration-options) below.

When you're done with all the configuration you'd like to do, continue with [Installing](installing.md).
[▶️](installing.md) When you're done with all the configuration you'd like to do, continue with [Installing](installing.md).


## Other configuration options


+ 2
- 2
docs/getting-the-playbook.md Просмотреть файл

@@ -1,6 +1,6 @@
# Getting the playbook

<sup>⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > Getting the playbook > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) </sup>
<sup>⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > Getting the playbook > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup>

This Ansible playbook is meant to be executed on your own computer (not the Matrix server).

@@ -37,4 +37,4 @@ You can extract this archive anywhere. You'll get a directory called `matrix-doc

---------------------------------------------

No matter which method you've used to download the playbook, you can proceed by [Configuring the playbook](configuring-playbook.md).
[▶️](configuring-playbook.md) No matter which method you've used to download the playbook, you can proceed by [Configuring the playbook](configuring-playbook.md).

+ 2
- 2
docs/installing.md Просмотреть файл

@@ -1,8 +1,8 @@
# Installing

<sup>⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > Installing </sup>
<sup>⚡️[Quick start](README.md) | [Prerequisites](prerequisites.md) > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > Installing</sup>

If you've [configured your DNS](configuring-dns.md) and have [configured the playbook](configuring-playbook.md), you can start the installation procedure.
If you've configured your DNS records and the playbook, you can start the installation procedure.

## Update Ansible roles



+ 2
- 2
docs/prerequisites.md Просмотреть файл

@@ -1,6 +1,6 @@
# Prerequisites

<sup>⚡️[Quick start](README.md) | Prerequisites > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md) </sup>
<sup>⚡️[Quick start](README.md) | Prerequisites > [Configuring your DNS server](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup>

To install Matrix services using this Ansible playbook, you need:

@@ -48,4 +48,4 @@ To install Matrix services using this Ansible playbook, you need:

---------------------------------------------

When ready to proceed, continue with [Configuring DNS](configuring-dns.md).
[▶️](configuring-dns.md) When ready to proceed, continue with [Configuring DNS](configuring-dns.md).

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