Update dns_config.md

add explanation of placeholder, to avoid typos and confusion
This commit is contained in:
Jaxom99 2019-10-15 23:07:28 +02:00 committed by GitHub
parent 044668b843
commit dde9f06cc6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -5,22 +5,23 @@ DNS (domain name system) is a system that converts human-readable addresses
easily accessible by human beings, and for some services like mail to work
properly, DNS must be configured.
If you're using an [automatic domain](/dns_nohost_me) provided by the YunoHost Project, the configuration should be
If you're using a nohost.me / noho.st / ynh.fr domain, the configuration should be
performed automatically. If you're using your own domain name (e.g. bought via
a registrar), you should manually configure your domain on your registrar's
interface.
## Recommended DNS configuration
NB: Examples here use the placeholder `your.domain.tld`, you have to replace it with your real domain, such as `www.yunohost.org`.
YunoHost provides a recommended DNS configuration, available via :
- the webadmin, in Domain > your.domain.tld > DNS configuration ;
- or the command line, `yunohost domain dns-conf your.domain.tld`
For specific needs or specific setups, and if you know what you're doing, you
might want or have to tweak these or add additional ones (e.g. to handle
might want or have to tweak these, or add additional ones (e.g. to handle
subdomains).
The recommended configuration typically looks like this :
The recommended configuration typically looks like this:
```bash
#
@ -51,7 +52,7 @@ mail._domainkey 3600 IN TXT "v=DKIM1; k=rsa; p=someHuuuuuuugeKey"
_dmarc 3600 IN TXT "v=DMARC1; p=none"
```
Though it might be easier to understand it if displayed like this :
Though it might be easier to understand it if displayed like this:
| Type | Name | Value |
@ -76,7 +77,5 @@ Though it might be easier to understand it if displayed like this :
- The dot at the end of `your.domain.tld.` is important ;) ;
- `@` corresponds to `your.domain.tld`, and e.g. `muc` corresponds to `muc.your.domain.tld` ;
- These are example values ! See your generated conf for the actual values you should use ;
- We recommend a [TTL](https://en.wikipedia.org/wiki/Time_to_live#DNS_records) of 3600 (1 hour). But you can use something else if you
know what you're doing ;
- Don't put an IPv6 record if you're not sure IPv6 really works on your server !
You might have issues with Let's Encrypt if it doesn't.
- We recommend a [TTL](https://en.wikipedia.org/wiki/Time_to_live#DNS_records) of 3600 (1 hour). But you can use something else if you know what you're doing ;
- Don't put an IPv6 record if you're not sure IPv6 really works on your server! You might have issues with Let's Encrypt if it doesn't.