소스 검색

Update docs/configuring-dns.md: move explanation about subdomain settings up

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3786/head
Suguru Hirahara 1 년 전
부모
커밋
acbc53a1c6
No known key found for this signature in database GPG 키 ID: E4F9743DAB4B7B75
1개의 변경된 파일6개의 추가작업 그리고 8개의 파일을 삭제
  1. +6
    -8
      docs/configuring-dns.md

+ 6
- 8
docs/configuring-dns.md 파일 보기

@@ -30,12 +30,18 @@ To serve the base domain (`example.com`) and [Element Web](configuring-playbook-
| A | `matrix` | - | - | - | `matrix-server-IP` | | A | `matrix` | - | - | - | `matrix-server-IP` |
| CNAME | `element` | - | - | - | `matrix.example.com` | | 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).

The `element.example.com` subdomain may be necessary, because this playbook installs the [Element Web](https://github.com/element-hq/element-web) client for you. If you'd rather instruct the playbook not to install Element Web (`matrix_client_element_enabled: false` when [Configuring the playbook](configuring-playbook.md) later), feel free to skip the `element.example.com` DNS record.

Be mindful as to how long it will take for the DNS records to propagate. Be mindful as to how long it will take for the DNS records to propagate.


If you are using Cloudflare DNS, make sure to disable the proxy and set all records to `DNS only`. Otherwise, fetching certificates will fail. If you are using Cloudflare DNS, make sure to disable the proxy and set all records to `DNS only`. Otherwise, fetching certificates will fail.


## DNS settings for optional services/features ## DNS settings for optional services/features


For other services which may need subdomain settings, see the table below and configure the DNS (`CNAME`) records accordingly.

| Used by component | Type | Host | Priority | Weight | Port | Target | | Used by component | Type | Host | Priority | Weight | Port | Target |
| -------------------------------------------------------------------------------------------------------------------------- | ----- | ------------------------------ | -------- | ------ | ---- | --------------------------- | | -------------------------------------------------------------------------------------------------------------------------- | ----- | ------------------------------ | -------- | ------ | ---- | --------------------------- |
| [ma1sd](configuring-playbook-ma1sd.md) identity server | SRV | `_matrix-identity._tcp` | 10 | 0 | 443 | `matrix.example.com` | | [ma1sd](configuring-playbook-ma1sd.md) identity server | SRV | `_matrix-identity._tcp` | 10 | 0 | 443 | `matrix.example.com` |
@@ -61,14 +67,6 @@ If you are using Cloudflare DNS, make sure to disable the proxy and set all reco


To make the ma1sd Identity Server (which this playbook may optionally install for you) enable its federation features, you need to set up a SRV record. When setting up a SRV record, if you are asked for a service and protocol instead of a hostname split the host value from the table where the period is. For example use service as `_matrix-identity` and protocol as `_tcp`. To make the ma1sd Identity Server (which this playbook may optionally install for you) enable its federation features, you need to set up a SRV record. When setting up a SRV record, if you are asked for a service and protocol instead of a hostname split the host value from the table where the period is. For example use service as `_matrix-identity` and protocol as `_tcp`.


## Subdomains setup

As the table above illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your new server's IP address (DNS `A` record or `CNAME` record is fine).

The `element.example.com` subdomain may be necessary, because this playbook installs the [Element Web](https://github.com/element-hq/element-web) client for you. If you'd rather instruct the playbook not to install Element Web (`matrix_client_element_enabled: false` when [Configuring the playbook](configuring-playbook.md) later), feel free to skip the `element.example.com` DNS record.

For other services which may need subdomain settings, see the table above and configure the DNS records accordingly.

## `_dmarc`, `postmoogle._domainkey` TXT and `matrix` MX records setup ## `_dmarc`, `postmoogle._domainkey` TXT and `matrix` MX records setup


To make the [postmoogle](configuring-playbook-bridge-postmoogle.md) email bridge enable its email sending features, you need to configure SPF (TXT), DMARC (TXT), DKIM (TXT) and MX records To make the [postmoogle](configuring-playbook-bridge-postmoogle.md) email bridge enable its email sending features, you need to configure SPF (TXT), DMARC (TXT), DKIM (TXT) and MX records


불러오는 중...
취소
저장