mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
[enh] Rework the DNS config page to be consistent with currently recommended conf in the CLI/webadmin (#595)
This commit is contained in:
Alexandre Aubin
GitHub
parent
b14c3c01af
commit
5cfb32554d
2 changed files with 145 additions and 111 deletions
126
dns_config.md
126
dns_config.md
|
|
@ -1,64 +1,82 @@
|
|||
## DNS zone configuration
|
||||
# DNS zone configuration
|
||||
|
||||
Sample DNS zone configuration for `domain.tld` domain name:
|
||||
DNS (domain name system) is a system that converts human-readable addresses
|
||||
(domain names) into machine-understandable addresses (IP). For your server to be
|
||||
easily accessible by human beings, and for some services like mail to work
|
||||
properly, DNS must be configured.
|
||||
|
||||
#### Use yunohost command to generate my DNS ZONE
|
||||
If you're using a nohost.me / noho.st 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
|
||||
|
||||
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
|
||||
subdomains).
|
||||
|
||||
The recommended configuration typically looks like this :
|
||||
|
||||
Connect to your server using yunohost and run the following as root
|
||||
```bash
|
||||
yunohost domain dns-conf domain.tld
|
||||
#
|
||||
# Basic ipv4/ipv6 records
|
||||
#
|
||||
@ 3600 IN A 111.222.33.44
|
||||
* 3600 IN A 111.222.33.44
|
||||
|
||||
# (If your server is IPv6 capable, there are some AAAA records)
|
||||
@ 3600 IN AAAA 2222:444:8888:3333:bbbb:5555:3333:1111
|
||||
* 3600 IN AAAA 2222:444:8888:3333:bbbb:5555:3333:1111
|
||||
|
||||
#
|
||||
# XMPP
|
||||
#
|
||||
_xmpp-client._tcp 3600 IN SRV 0 5 5222 your.domain.tld.
|
||||
_xmpp-server._tcp 3600 IN SRV 0 5 5269 your.domain.tld.
|
||||
muc 3600 IN CNAME @
|
||||
pubsub 3600 IN CNAME @
|
||||
vjud 3600 IN CNAME @
|
||||
|
||||
#
|
||||
# Mail (MX, SPF, DKIM and DMARC)
|
||||
#
|
||||
@ 3600 IN MX 10 your.domain.tld.
|
||||
@ 3600 IN TXT "v=spf1 a mx ip4:111.222.33.44 -all"
|
||||
mail._domainkey 3600 IN TXT "v=DKIM1; k=rsa; p=someHuuuuuuugeKey"
|
||||
_dmarc 3600 IN TXT "v=DMARC1; p=none"
|
||||
```
|
||||
|
||||
#### Redirection from the domain name to the IP address
|
||||
```bash
|
||||
@ 1800 IN A 111.222.333.444 # (Minimal) IPv4
|
||||
@ 1800 IN AAAA 2001:AABB:CCDD:EEFF:1122:3344:5566:7788 # IPv6
|
||||
```
|
||||
Though it might be easier to understand it if displayed like this :
|
||||
|
||||
#### Redirection from the domain name and subdomains to the IP address
|
||||
```bash
|
||||
* 1800 IN A 111.222.333.444 # Wildcard: *.domain.tld and domain.tld redirection to the IP address
|
||||
* 1800 IN AAAA 2001:AABB:CCDD:EEFF:1122:3344:5566:7788
|
||||
```
|
||||
|
||||
#### Subdomains
|
||||
```bash
|
||||
www 1800 IN CNAME @ # accesible at www.domain.tld
|
||||
```
|
||||
| Type | Name | Value |
|
||||
| :-----: | :--------------------: | :--------------------------------------------------: |
|
||||
| **A** | **@** | `111.222.333.444` (your IPv4) |
|
||||
| A | * | `111.222.333.444` (your IPv4) |
|
||||
| AAAA | @ | `2222:444:8888:3333:bbbb:5555:3333:1111` (your IPv6) |
|
||||
| AAAA | * | `2222:444:8888:3333:bbbb:5555:3333:1111` (your IPv6) |
|
||||
| **SRV** | **_xmpp-client._tcp** | `0 5 5222 your.domain.tld.` |
|
||||
| **SRV** | **_xmpp-server._tcp** | `0 5 5269 your.domain.tld.` |
|
||||
| CNAME | muc | `@` |
|
||||
| CNAME | pubsub | `@` |
|
||||
| CNAME | vjud | `@` |
|
||||
| **MX** | **@** | `your.domain.tld.` (and priority: 10) |
|
||||
| TXT | @ | `"v=spf1 a mx ip4:111.222.33.44 -all"` |
|
||||
| TXT | mail._domainkey | `"v=DKIM1; k=rsa; p=someHuuuuuuugeKey"` |
|
||||
| TXT | _dmarc | `"v=DMARC1; p=none"` |
|
||||
|
||||
#### XMPP
|
||||
```bash
|
||||
_xmpp-client._tcp 1800 IN SRV 0 5 5222 domain.tld. # (Minimal) clients connection
|
||||
_xmpp-server._tcp 1800 IN SRV 0 5 5269 domain.tld. # (Minimal) servers connection
|
||||
#### A few notes about this table
|
||||
|
||||
muc 1800 IN CNAME @ # multi-user chat rooms at muc.domain.tld
|
||||
anonymous 1800 IN CNAME @ # connection without account at `anonymous.domain.tld`
|
||||
bosh 1800 CNAME @ # BOSH
|
||||
_xmppconnect 1800 TXT "_xmpp-client-xbosh=https://bosh.domain.tld:5281/http-bind"
|
||||
pubsub 1800 IN CNAME @
|
||||
vjud 1800 IN CNAME @
|
||||
```
|
||||
|
||||
#### Email
|
||||
```bash
|
||||
@ 1800 IN MX 10 domain.tld. # (Minimal)
|
||||
@ 1800 IN TXT "v=spf1 a mx -all"
|
||||
```
|
||||
|
||||
You should also consult the [DKIM documentation](#/dkim). DKIM allows yours mails not to be considered by spam by other mail service. In fact DKIM ask you to add an entry in your zone.
|
||||
|
||||
#### Set up
|
||||
Replace:
|
||||
- "`domain.tld`" with your own domain preserving the dot at the end.
|
||||
- IP samples values with your server IP addresses:
|
||||
* `111.222.333.444`: [IPv4](http://ip.yunohost.org/).
|
||||
* `2001:AABB:CCDD:EEFF:1122:3344:5566:7788`: [IPv6](http://ip6.yunohost.org/).
|
||||
|
||||
DNS lines for subdomains, XMPP and email does not work without a redirection from the domain name to the IP address (one line is enough) because they depend on it.
|
||||
|
||||
<div class="alert alert-info"><b>To begin:</b> lines with "(Minimal)" are the minimal required DNS entries to make redirection work from the domain name to the IP adress, XMPP and email.</div>
|
||||
|
||||
<div class="alert alert-warning"><b>Warning:</b> <b>@</b> is the default domain name currently defined, some registrar (like OVH) does not accept it, so replace @ by your domain name (domain.tld**.**) with a dot at the end.</div>
|
||||
|
||||
#### Time to live
|
||||
All DNS lines above have `1800` value (30 minutes). It corresponds to [Time to live (TTL)](https://en.wikipedia.org/wiki/Time_to_live#DNS_records) which represents and indicate time, in seconds, during which the DNS line can be kept in the cache. After this time, the information must me considered obsolete and must be updated.
|
||||
- Not all these lines are absolutely necessary. For a minimal setup, you only need the records in bold.
|
||||
- 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.
|
||||
|
|
|
|||
130
dns_config_fr.md
130
dns_config_fr.md
|
|
@ -1,66 +1,82 @@
|
|||
## Configuration de la zone DNS
|
||||
# Configuration de la zone DNS
|
||||
|
||||
Exemple de configuration des entrées de la zone DNS pour le nom de domaine `domain.tld` :
|
||||
DNS (système de nom de domaine) est un élément essentiel d'Internet qui permet
|
||||
de convertir des adresses compréhensible par les êtres humains (les noms de
|
||||
domaines) en adresses compréhensibles par la machine (les IPs). Pour que
|
||||
votre serveur soit facilement accessible par d'autres êtres humains, et pour
|
||||
que certains services comme le mail fonctionnent correctement, il est nécessaire
|
||||
de configurer la zone DNS de votre domaine.
|
||||
|
||||
#### Utiliser la commande yunohost pour générer ma zone DNS
|
||||
Si vous utilisez un domaine en nohost.me / noho.st domain, la configuration
|
||||
devrait être faite automatiquement. Si vous utilisez votre propre nom de domaine
|
||||
(e.g. acheté chez un registrar), il vous faut configurer manuellement votre
|
||||
domaine via l'interface de votre registrar.
|
||||
|
||||
## Configuration DNS recommandée
|
||||
|
||||
YunoHost fourni une configuration DNS recommandée, accessible via :
|
||||
- la webadmin, dans Domaines > votre.domain.tld > Configuration DNS ;
|
||||
- ou la ligne de commande, `yunohost domain dns-conf votre.domaine.tld`
|
||||
|
||||
Pour certains besoins ou installations particulières, et si vous savez ce que
|
||||
vous faîtes, il vous faudra peut-être modifier cette recommendation ou ajouter
|
||||
d'autres enregistrements (e.g. pour gérer des sous-domaines).
|
||||
|
||||
La configuration recommandée ressemble typiquement à :
|
||||
|
||||
Connecter vous à votre serveur et lancer la commande suivante.
|
||||
```bash
|
||||
yunohost domain dns-conf domain.tld
|
||||
#
|
||||
# Enregistrements IPv4/IPv6 basiques
|
||||
#
|
||||
@ 3600 IN A 111.222.33.44
|
||||
* 3600 IN A 111.222.33.44
|
||||
|
||||
# (Si votre serveur supporter l'IPv6, il a des enregistrements AAAA)
|
||||
@ 3600 IN AAAA 2222:444:8888:3333:bbbb:5555:3333:1111
|
||||
* 3600 IN AAAA 2222:444:8888:3333:bbbb:5555:3333:1111
|
||||
|
||||
#
|
||||
# XMPP
|
||||
#
|
||||
_xmpp-client._tcp 3600 IN SRV 0 5 5222 votre.domaine.tld.
|
||||
_xmpp-server._tcp 3600 IN SRV 0 5 5269 votre.domaine.tld.
|
||||
muc 3600 IN CNAME @
|
||||
pubsub 3600 IN CNAME @
|
||||
vjud 3600 IN CNAME @
|
||||
|
||||
#
|
||||
# Mail (MX, SPF, DKIM et DMARC)
|
||||
#
|
||||
@ 3600 IN MX 10 votre.domaine.tld.
|
||||
@ 3600 IN TXT "v=spf1 a mx ip4:111.222.33.44 -all"
|
||||
mail._domainkey 3600 IN TXT "v=DKIM1; k=rsa; p=uneGrannnnndeClef"
|
||||
_dmarc 3600 IN TXT "v=DMARC1; p=none"
|
||||
```
|
||||
|
||||
#### Redirection du nom de domaine vers l’adresse IP
|
||||
```bash
|
||||
@ 1800 IN A 111.222.333.444 # (Minimum) IPv4
|
||||
@ 1800 IN AAAA 2001:AABB:CCDD:EEFF:1122:3344:5566:7788 # IPv6
|
||||
```
|
||||
Mais il est peut-être plus facile de la comprendre si affichée de la façon
|
||||
suivante :
|
||||
|
||||
#### Redirection du nom de domaine et de tous les sous-domaines vers l’adresse IP
|
||||
```bash
|
||||
* 1800 IN A 111.222.333.444 # Wildcard : *.domain.tld et domain.tld pointent vers l’adresse IP.
|
||||
* 1800 IN AAAA 2001:AABB:CCDD:EEFF:1122:3344:5566:7788
|
||||
```
|
||||
| Type | Nom | Valeur |
|
||||
| :-----: | :--------------------: | :----------------------------------------------------: |
|
||||
| **A** | **@** | `111.222.333.444` (votre IPv4) |
|
||||
| A | * | `111.222.333.444` (votre IPv4) |
|
||||
| AAAA | @ | `2222:444:8888:3333:bbbb:5555:3333:1111` (votre IPv6) |
|
||||
| AAAA | * | `2222:444:8888:3333:bbbb:5555:3333:1111` (votre IPv6) |
|
||||
| **SRV** | **_xmpp-client._tcp** | `0 5 5222 votre.domaine.tld.` |
|
||||
| **SRV** | **_xmpp-server._tcp** | `0 5 5269 votre.domaine.tld.` |
|
||||
| CNAME | muc | `@` |
|
||||
| CNAME | pubsub | `@` |
|
||||
| CNAME | vjud | `@` |
|
||||
| **MX** | **@** | `votre.domaine.tld.` (et priorité: 10) |
|
||||
| TXT | @ | `"v=spf1 a mx ip4:111.222.33.44 -all"` |
|
||||
| TXT | mail._domainkey | `"v=DKIM1; k=rsa; p=uneGrannnndeClef"` |
|
||||
| TXT | _dmarc | `"v=DMARC1; p=none"` |
|
||||
|
||||
#### Sous-domaines
|
||||
```bash
|
||||
www 1800 IN CNAME @ # accessible sur www.domain.tld
|
||||
```
|
||||
#### Quelques notes à propos de cette table
|
||||
|
||||
#### XMPP
|
||||
```bash
|
||||
_xmpp-client._tcp 1800 IN SRV 0 5 5222 domain.tld. # (Minimum) connexions avec les clients
|
||||
_xmpp-server._tcp 1800 IN SRV 0 5 5269 domain.tld. # (Minimum) connexions entre serveurs
|
||||
|
||||
muc 1800 IN CNAME @ # salons de discussion sur `muc.domain.tld`
|
||||
anonymous 1800 IN CNAME @ # connexion sans compte sur `anonymous.domain.tld`
|
||||
bosh 1800 CNAME @ # BOSH
|
||||
_xmppconnect 1800 TXT "_xmpp-client-xbosh=https://bosh.domain.tld:5281/http-bind"
|
||||
pubsub 1800 IN CNAME @
|
||||
vjud 1800 IN CNAME @
|
||||
```
|
||||
|
||||
#### Email
|
||||
```bash
|
||||
@ 1800 IN MX 10 domain.tld. # (Minimum)
|
||||
@ 1800 IN TXT "v=spf1 a mx -all"
|
||||
```
|
||||
<br />
|
||||
|
||||
Vous devriez aussi consulter [la documentation de DKIM](#/dkim_fr). DKIM permet d'éviter que vos mails soit considérés comme SPAM et DKIM nécessite une entrée spécifique dans votre zone DNS.
|
||||
|
||||
#### Mise en place
|
||||
Remplacez :
|
||||
* « `domain.tld` » par votre propre nom de domaine en conservant le point à la fin.
|
||||
* les adresses IP d’exemple par celles de votre serveur :
|
||||
* `111.222.333.444` : [IPv4](http://ip.yunohost.org/).
|
||||
* `2001:AABB:CCDD:EEFF:1122:3344:5566:7788` : [IPv6](http://ip6.yunohost.org/).
|
||||
|
||||
Les entrées DNS sous domaines, XMPP et email ne fonctionnent pas sans une redirection du nom de domaine vers l’adresse IP (une ligne est suffisante) étant donné qu’elles en sont dépendantes.
|
||||
|
||||
<div class="alert alert-info">**Pour débuter :** les lignes avec « (Minimum) » sont les entrées DNS minimales requises pour avoir une redirection du nom de domaine vers l’adresse IP, XMPP et le courrier électronique qui fonctionnent.</div>
|
||||
|
||||
<div class="alert alert-warning">**Attention :** le **@** représente le nom de domaine par défaut que l’on est en train de définir, certains bureaux d’enregistrement ne l’acceptent pas (ex : OVH). Il faut donc remplacer le « @ » par votre nom de domaine (domain.tld**.**) sans oublier un point à la fin.</div>
|
||||
|
||||
#### Time to live
|
||||
Toutes les entrées DNS ci-dessus ont la valeur `1800` (30 minutes). Elle correspond au
|
||||
[Time to live (TTL)](https://fr.wikipedia.org/wiki/Time_to_Live#Le_Time_to_Live_dans_le_DNS) qui représente et indique le temps, en secondes, durant lequel l’entrée DNS peut être conservée en cache. Passé ce délai, l’information doit être considérée comme obsolète et doit être mise à jour.
|
||||
- Tous ces enregistrements ne sont pas nécessaires. Pour une installation minimale, seuls les enregistrements en gras sont nécessaires.
|
||||
- Le point à la fin de `votre.domaine.tld.` est important ;) ;
|
||||
- `@` corresponds à `votre.domaine.tld`, et par ex. `muc` corresponds à `muc.votre.domaine.tld` ;
|
||||
- Les valeurs montrées sont des valeurs d'exemple ! Référez-vous à la configuration générée chez vous pour savoir quelles valeurs utiliser.
|
||||
- Nous recommendons un [TTL](https://fr.wikipedia.org/wiki/Time_to_Live#Le_Time_to_Live_dans_le_DNS) de 3600 (1 heure). Mais vous pouvez utiliser une autre valeur si vous savez ce que vous faîtes ;
|
||||
- Ne mettez pas d'enregistrement IPv6 si vous n'êtes pas certains que l'IPv6 fonctionne sur votre serveur ! Vous aurez des problèmes avec Let's Encrypt si ce n'est pas le cas.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue