Merge pull request #1791 from YunoHost/add-mdns

Add mDNS documentation
This commit is contained in:
tituspijean 2021-11-12 21:10:03 +01:00 committed by GitHub
commit 6a95736d61
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 50 additions and 11 deletions

View file

@ -431,6 +431,7 @@ Pour y parvenir, vous devez vous connecter à votre Raspberry Pi en tant que roo
``` ```
ssh root@yunohost.local ssh root@yunohost.local
``` ```
(utilisez `yunohost-2.local`, etc. s'il y a plusieurs serveurs YunoHost sur le réseau)
Ensuite, lancez les commandes suivantes pour contourner le dysfonctionnement de Metronome : Ensuite, lancez les commandes suivantes pour contourner le dysfonctionnement de Metronome :
``` ```
@ -486,7 +487,7 @@ curl https://install.yunohost.org | bash
[ui-tabs position="top-left" active="0" theme="lite"] [ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="À partir de l'interface web"] [ui-tab title="À partir de l'interface web"]
{%if at_home %} {%if at_home %}
Dans un navigateur web, tapez dans la barre d'adresse **{% if internetcube %}`https://internetcube.local`{% else %}`https://yunohost.local`{% endif %}**. Dans un navigateur web, tapez dans la barre d'adresse **{% if internetcube %}`https://internetcube.local`{% else %}`https://yunohost.local` (utilisez `yunohost-2.local`, etc. s'il y a plusieurs serveurs YunoHost sur le réseau){% endif %}**.
!!! Si ça ne fonctionne pas, vous devez [chercher l'adresse IP locale du serveur](/finding_the_local_ip). L'adresse ressemble typiquement à `192.168.x.y`, et vous devriez taper `https://192.168.x.y` dans la barre d'adresse du navigateur. !!! Si ça ne fonctionne pas, vous devez [chercher l'adresse IP locale du serveur](/finding_the_local_ip). L'adresse ressemble typiquement à `192.168.x.y`, et vous devriez taper `https://192.168.x.y` dans la barre d'adresse du navigateur.
{% else %} {% else %}

View file

@ -430,6 +430,7 @@ To achieve this, you need to connect on your raspberry pi as root user [via SSH]
``` ```
ssh root@yunohost.local ssh root@yunohost.local
``` ```
(o `yunohost-2.local`, e così via se più server YunoHost sono sulla tua rete)
Then run the following commands to work around the metronome issue: Then run the following commands to work around the metronome issue:
``` ```
@ -486,7 +487,7 @@ curl https://install.yunohost.org | bash
[ui-tabs position="top-left" active="0" theme="lite"] [ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="From the web interface"] [ui-tab title="From the web interface"]
{%if at_home %} {%if at_home %}
In an internet browser, type **{% if internetcube %}`https://internetcube.local`{% else %}`https://yunohost.local`{% endif %}**. In an internet browser, type **{% if internetcube %}`https://internetcube.local`{% else %}`https://yunohost.local` (o `yunohost-2.local`, e così via se più server YunoHost sono sulla tua rete){% endif %}**.
!!! If this doesn't work, you can [look for the the local IP address of your server](/finding_the_local_ip). The address typically looks like `192.168.x.y`, and you should therefore type `https://192.168.x.y` in your browser's address bar. !!! If this doesn't work, you can [look for the the local IP address of your server](/finding_the_local_ip). The address typically looks like `192.168.x.y`, and you should therefore type `https://192.168.x.y` in your browser's address bar.
{% else %} {% else %}

View file

@ -430,6 +430,7 @@ To achieve this, you need to connect on your raspberry pi as root user [via SSH]
``` ```
ssh root@yunohost.local ssh root@yunohost.local
``` ```
(or `yunohost-2.local`, and so on if multiple YunoHost servers are on your network)
Then run the following commands to work around the metronome issue: Then run the following commands to work around the metronome issue:
``` ```
@ -486,7 +487,7 @@ curl https://install.yunohost.org | bash
[ui-tabs position="top-left" active="0" theme="lite"] [ui-tabs position="top-left" active="0" theme="lite"]
[ui-tab title="From the web interface"] [ui-tab title="From the web interface"]
{%if at_home %} {%if at_home %}
In an internet browser, type **{% if internetcube %}`https://internetcube.local`{% else %}`https://yunohost.local`{% endif %}**. In an internet browser, type **{% if internetcube %}`https://internetcube.local`{% else %}`https://yunohost.local` (or `yunohost-2.local`, and so on if multiple YunoHost servers are on your network){% endif %}**.
!!! If this doesn't work, you can [look for the the local IP address of your server](/finding_the_local_ip). The address typically looks like `192.168.x.y`, and you should therefore type `https://192.168.x.y` in your browser's address bar. !!! If this doesn't work, you can [look for the the local IP address of your server](/finding_the_local_ip). The address typically looks like `192.168.x.y`, and you should therefore type `https://192.168.x.y` in your browser's address bar.
{% else %} {% else %}

View file

@ -38,8 +38,8 @@ Durant la post-installation, vous avez défini un mot de passe d'administration.
### Adresse à utiliser ### Adresse à utiliser
Si vous hébergez votre serveur **à la maison** (par ex. Raspberry Pi ou OLinuXino ou vieil ordinateur) Si vous hébergez votre serveur **à la maison** (par ex. Raspberry Pi ou OLinuXino ou vieil ordinateur)
- vous devriez pouvoir vous connecter à la machine en utilisant `yunohost.local`. - vous devriez pouvoir vous connecter à la machine en utilisant `yunohost.local` (ou `yunohost-2.local`, selon le nombre de serveurs sur le réseau).
- si `yunohost.local` ne fonctionne pas, il vous faut [trouver l'IP locale de votre serveur](/finding_the_local_ip). - si `yunohost.local` et consorts ne fonctionnent pas, il vous faut [trouver l'IP locale de votre serveur](/finding_the_local_ip).
- si vous avez installé votre serveur à la maison mais essayez d'y accéder depuis l'extérieur du réseau local, assurez-vous d'avoir bien configuré une redirection de port pour le port 22. - si vous avez installé votre serveur à la maison mais essayez d'y accéder depuis l'extérieur du réseau local, assurez-vous d'avoir bien configuré une redirection de port pour le port 22.
S'il s'agit d'une machine distante (VPS), votre fournisseur devrait vous avoir communiqué l'IP de votre machine. S'il s'agit d'une machine distante (VPS), votre fournisseur devrait vous avoir communiqué l'IP de votre machine.

View file

@ -39,8 +39,8 @@ During the postinstall, you've been asked to choose an administration password.
### Address to use ### Address to use
If you are **installing at home** (e.g. on a Raspberry Pi or OLinuXino or old computer): If you are **installing at home** (e.g. on a Raspberry Pi or OLinuXino or old computer):
- you should be able to connect to your server using `yunohost.local`. - you should be able to connect to your server using `yunohost.local` (or `yunohost-2.local`, depending on how many servers are on your network).
- if `yunohost.local` does not work, your need to [find out the local IP of the server](/finding_the_local_ip). - if `yunohost.local` and the like do not work, your need to [find out the local IP of the server](/finding_the_local_ip).
- if you installed a server at home but are attempting to connect from outside your local network, make sure port 22 is correctly forwarded to your server. - if you installed a server at home but are attempting to connect from outside your local network, make sure port 22 is correctly forwarded to your server.
@ -60,10 +60,10 @@ ssh root@11.22.33.44
# or after the postinstall: # or after the postinstall:
ssh admin@11.22.33.44 ssh admin@11.22.33.44
# avec le nom de domaine plutôt que l'ip (plus pratique): # using the domain name instead of the IP (more convenient)
ssh admin@votre.domaine.tld ssh admin@votre.domaine.tld
# using the domain name instead of the IP (more convenient) # using the local domain name instead of the IP (for local access)
ssh admin@yunohost.local ssh admin@yunohost.local
# if you changed the SSH port # if you changed the SSH port

View file

@ -17,6 +17,24 @@ Le domaine choisi lors de la configuration initiale (post-installation) est déf
Enfin, il faut noter que, dans le contexte de YunoHost, il n'y a pas de hiérarchie entre les domaines qu'il connaît. Dans l'exemple précédent, on peut ajouter un troisième domaine `foo.yolo.com` - mais il serait considéré comme un domaine indépendant de `yolo.com`. Enfin, il faut noter que, dans le contexte de YunoHost, il n'y a pas de hiérarchie entre les domaines qu'il connaît. Dans l'exemple précédent, on peut ajouter un troisième domaine `foo.yolo.com` - mais il serait considéré comme un domaine indépendant de `yolo.com`.
## Domaines locaux
À partir de YunoHost v4.3, les domaines finissant par `.local` sont pleinement supportés, en plus du `yunohost.local` par défaut.
Ils n'utilisent pas le protocole DNS mais mDNS (appelé aussi Zeroconf, Bonjour), qui permet leur diffusion sans configuration particulière mais exclusivement sur votre réseau local, ou votre VPN.
Leur utilisation est donc parfaitement adaptée si vous ne prévoyez pas de rendre une de vos apps disponible sur l'Internet.
!!!! Le protocole mDNS ne permet pas d'ajouter des sous-domaines. Ainsi `domaine.local` est valide, `sous.domain.local` ne l'est pas.
C'est le service `yunomdns` qui se charge de diffuser l'existence de vos domaines `.local` sur votre réseau.
Il possède un fichier de configuration, `/etc/yunohost/mdns.yml`, qui permet de choisir quels domaines sont diffusés, et sur quelles interfaces réseau.
Ce fichier est régénéré automatiquement dès que vous ajoutez ou supprimez un domaine `.local`.
Le service cherchera toujours à diffuser le domaine `yunohost.local`. Si vous avez plusieurs serveurs YunoHost sur votre réseau, alors tentez `yunohost-2.local`, etc.
Le chiffre risque de changer selon quel serveur démarre en premier, donc ne comptez pas dessus pour y installer des apps : créez vos propres domaines locaux.
!! Malheureusement, les appareils Android ne semblent pas écouter le protocole mDNS.
!! Pour profiter des domaines `.local` sur vos appareils Android, vous devez entrer l'adresse IP locale de votre serveur YunoHost dans leur paramètre DNS.
## Configuration DNS ## Configuration DNS
DNS (Domain Name System) est un système qui permet aux ordinateurs du monde entier de traduire les noms de domaine lisibles par l'homme (comme `yolo.com`) en adresses IP compréhensibles par les machines (comme `11.22.33.44`). Pour que cette traduction (et d'autres fonctionnalités) fonctionne, il faut configurer soigneusement les enregistrements DNS. DNS (Domain Name System) est un système qui permet aux ordinateurs du monde entier de traduire les noms de domaine lisibles par l'homme (comme `yolo.com`) en adresses IP compréhensibles par les machines (comme `11.22.33.44`). Pour que cette traduction (et d'autres fonctionnalités) fonctionne, il faut configurer soigneusement les enregistrements DNS.

View file

@ -21,6 +21,24 @@ Finally, take note that, in the context of YunoHost, there is no hierarchy betwe
If your domain has special, non-latin characters, you need to use its [internationalized version](https://en.wikipedia.org/wiki/Internationalized_domain_name) through [Punycode](https://en.wikipedia.org/wiki/Punycode). You can use [this converter](https://www.charset.org/punycode), and use the converted domain name in your YunoHost configuration. If your domain has special, non-latin characters, you need to use its [internationalized version](https://en.wikipedia.org/wiki/Internationalized_domain_name) through [Punycode](https://en.wikipedia.org/wiki/Punycode). You can use [this converter](https://www.charset.org/punycode), and use the converted domain name in your YunoHost configuration.
## Local domains
Starting from YunoHost v4.3, domains ending by `.local` are fully supported, in addition to the default `yunohost.local`.
They do not use the DNS protocol, but the mDNS one (also known as Zeroconf, Bonjour), which allows them to be published with no specific configuration but exclusively on your local network or VPN.
Their use is this especially suitable when you do not want one of your apps to be available on the Internet.
!!!! mDNS protocol does not allow for subdomains to be created. So `domain.local` will work, while `sub.domain.local` is not possible.
`Yunomdns` service takes care of publishing your `.local` domains on your network.
It has a configuration file, `/etc/yunohost/mdns.yml`, which allows you to choose which domains are published, and on which network interfaces.
This file is automatically regenerated whenever you add or delete a `.local` domain.
The service will always try to publish `yunohost.local`. If you have multiple YunoHost servers on your network, try `yunohost-2.local`, and so on.
The number may change depending on which server starts first, so do not rely on it to use actual apps and create your own domains.
!! Unfortunately, Android devices do not seem to be listening to mDNS protocol.
!! To be able to reach `.local` domains on your Android devices, you will have to add in their DNS settings your YunoHost server's local IP address.
## DNS configuration ## DNS configuration
DNS (Domain Name System) is a system that allows computers from around the world to translate human-readable domain names (such as `yolo.com`) to machine-understandable adresses called IP addresses (such as `11.22.33.44`). For this translation (and other features) to work, you must carefully configure DNS records. DNS (Domain Name System) is a system that allows computers from around the world to translate human-readable domain names (such as `yolo.com`) to machine-understandable adresses called IP addresses (such as `11.22.33.44`). For this translation (and other features) to work, you must carefully configure DNS records.

View file

@ -117,7 +117,7 @@ Pour connaître votre IP locale, certaines BOX proposent une cartographie du ré
sudo arp-scan --local sudo arp-scan --local
``` ```
Vous pouvez aussi essayer avec le domaine `yunohost.local` s'il n'y a qu'un seul YunoHost sur votre réseau. Vous pouvez aussi essayer avec le domaine `yunohost.local`, `yunohost-2.local`, etc. selon le nombre de serveurs YunoHost sur votre réseau.
Il faut voir avec votre fournisseur de VPN pour renouveler le VPN et mettre à jour les paramètre de l'app VPN Client. Il faut voir avec votre fournisseur de VPN pour renouveler le VPN et mettre à jour les paramètre de l'app VPN Client.

View file

@ -108,7 +108,7 @@ In that case, contact your VPN provider to renew it and update the parameters of
Meanwhile, try reaching your server if it is at home, by: Meanwhile, try reaching your server if it is at home, by:
- its local IP, retrievable from your router configuration panel or `sudo arp-scan --local` - its local IP, retrievable from your router configuration panel or `sudo arp-scan --local`
- reaching it at `yunohost.local`, if it is at home and that you have only one YunoHost server in your network. - reaching it at `yunohost.local`, or `yunohost-2.local`, etc. depending on how many YunoHost servers are on your network.
!!! To be completed. !!! To be completed.