[enh] Rework page / explanations about port forwarding (#599)

* [enh] Rework page / explanations about port forwarding
* Adding back link to french tutorial for port forwarding
This commit is contained in:
Alexandre Aubin 2017-11-01 19:23:46 +01:00 committed by GitHub
parent 5cfb32554d
commit 0e25e5b41a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 77 additions and 53 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 175 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 176 KiB

Binary file not shown.

Binary file not shown.

View file

@ -1,35 +1,46 @@
# Configuration box/router
# Configure port-forwarding
<a class="btn btn-lg btn-default" href="http://ports.yunohost.org">Check ports are open</a>
If you are self-hosting at home and without a VPN, you need to forward ports on your home router ("Internet box"). If you want a short explanation on what is and why you need port forwarding, have a look in [this page](port_forwarding).
#### Access to box/routeur administration
In the URL bar of your web browser put:
```bash
192.168.0.1 or 192.168.1.1
```
Then you will need to authentificate.
### 0. Diagnose ports opened
#### Opening ports
Opening following ports are necessary to make works differents services.
After configuring port forwarding, you should be able to validate with this small tool that your ports are correctly forwarded :
<a class="btn btn-default" href="http://ports.yunohost.org">Check which ports are forwarded</a>
### 1. Access your box/router administration interface
Your box/router admin interface is usually reachable via http://192.168.0.1 or http://192.168.1.1. Then, you will probably need to authenticate yourself with your internet server provider's credentials.
### 2. Find the local IP of your server
Identify what is the local IP of your server, either :
- from your box/router interface, which might list devices connected
- from the YunoHost webadmin, in 'State of the server', 'Network'
- from the command line in your server, by running `ip a | grep "scope global" | awk '{print $2}'`
A local IP address typically looks like `192.168.xx.yy`, or `10.0.xx.yy`.
### 3. Forwarding ports
In your router admin interface, look for something like 'router configuration' or 'port forwarding'. The naming differs among the various kinds of boxes.
Opening the ports listed below is necessary for the various services available in YunoHost to work. For each of them, the 'TCP' forwarding is needed. Some interfaces refer to 'external' and 'internal' ports : these are the same in our case.
**TCP:**
* Web: 80 <small>(HTTP)</small>, 443 <small>(HTTPS)</small>
* [SSH](/ssh_en): 22
* [XMPP](/XMPP_en): 5222 <small>(clients)</small>, 5269 <small>(servers)</small>
* [Email](/email_en): 25, 465 <small>(SMTP)</small>, 587 <small>(SMTP with SSL)</small>, 993 <small>(IMAP)</small>
* [DNS](/dns_en): 53
##### UPnP
UPnP permit automatically forward ports.
<div class="alert alert-warning" markdown="1">
<span class="glyphicon glyphicon-warning-sign"></span> Some internet service providers block port 25 (mail SMTP) by default to fight spam. Some other ISP don't allow to use port 80/443 (web) freely, though it's less likely. Depending on the ISP, it might be possible to open them in the admin interface... Check [this page](isp_en) for more info.
</div>
In some case, after changing your box configuration (ex: add IPv6, or unlock SMTP…) and a reboot. It happens that ports are no longer forwarded. So you have to reload your firewall configuration:
## Automatic port forwarding / UPnP
A technology called UPnP is available on some internet boxes / routers and allows to automatically forward ports by the machine who needs them. If UPnP is enabled in your local network, then running this command should automatically open the port for you :
```bash
sudo yunohost firewall reload
```
##### Manual forward ports
In the case that UPnP doesnt works, manual ports forward are necessary.
##### Email
Internet service porviders blocks port 25 to avoid spam. To send mails, youll need to forward port 25.

View file

@ -1,50 +1,51 @@
# Configuration box/routeur
# Configurer la redirection des ports
<a class="btn btn-lg btn-default" href="http://ports.yunohost.org">Vérifier que les ports sont ouverts</a>
Si vous vous auto-hébergez à la maison et sans VPN, il vous faut rediriger les ports de votre routeur ("machin-box"). Si vous souhaitez une explication courte de ce qu'est et pourquoi vous avez besoin de rediriger les ports, vous pouvez jeter un oeil à [cette page](port_forwarding_fr). [Cette page](https://craym.eu/tutoriels/utilitaires/ouvrir_les_ports_de_sa_box.html) propose également des explications détaillées sur le fonctionnement des ports, et les étapes de configuration pour différents routeurs.
### Accès à ladministration de la box/routeur
Allez à ladresse suivante : http://192.168.0.1 (ou celle-ci http://192.168.1.1). Puis authentifier-vous.
### 0. Diagnostiquer les ports ouverts
### Tutoriel
* [Tutoriel pour les ouvrir les ports sur les boxs dOrange, Free, SFR, Dartybox, Belgacom et sur les routeurs Netgear](https://craym.eu/tutoriels/utilitaires/ouvrir_les_ports_de_sa_box.html).
Une fois que vous aurez configuré la redirection, vous devriez pouvoir valider avec ce petit outil que vos ports sont bien redirigés :
<a class="btn btn-default" href="http://ports.yunohost.org">Vérifier la redirection des ports</a>
### Redirection des ports
La redirection des ports suivants est nécessaire au fonctionnement des différents services.
### 1. Accéder à l'interface d'administration de votre box/routeur
**TCP :**
* Web : 80 <small>(HTTP)</small>, 443 <small>(HTTPS)</small>
* [SSH](ssh_fr) : 22
* [XMPP](XMPP_fr) : 5222 <small>(clients)</small>, 5269 <small>(serveurs)</small>
* [Courriel](email_fr) : 25, 465 <small>(SMTP)</small>, 587 <small>(SMTP avec chiffrement)</small>, 993 <small>(IMAP)</small>
* [DNS](dns_fr) : 53
L'interface d'administration est généralement accessible via http://192.168.0.1 ou http://192.168.1.1.
Ensuite, il vous faudra peut-être vous authentifier avec les identifiants
fournis par votre fournisseur d'accès internet (FAI).
**UDP:**
* [DNS](dns_fr) : 53
### 2. Trouver l'IP locale de votre serveur
Identifiez quelle est l'IP locale de votre serveur, soit :
- depuis l'interface de votre routeur/box, qui liste peut-être les dispostifis
connectés.
- depuis la webadmin de YunoHost, dans 'État du serveur', 'Réseau'
- depuis la ligne de commande dans votre serveur, par exemple avec `ip a | grep "scope global" | awk '{print $2}'`
Une adresse IP locale ressemble généralement à `192.168.xx.yy`, ou `10.0.xx.yy`.
### 3. Rediriger les ports
Dans l'interface d'administration de votre box/routeur, il vous faut trouver
une catégorie comme 'Configuration du routeur', ou 'Redirections de ports'. Le
nom diffère suivant le type / marque de la box...
Il vous faut ensuite rediriger chacun des ports listés ci-dessous vers l'IP locale de votre serveur pour que les différents services de YunoHost fonctionnent. Pour chacun d'eux, une redirection 'TCP' est nécessaire. Certains interfaces font références à un port 'externe' et un port 'interne' : dans notre cas il s'agit du même.
* Web: 80 <small>(HTTP)</small>, 443 <small>(HTTPS)</small>
* [SSH](/ssh_fr): 22
* [XMPP](/XMPP_fr): 5222 <small>(clients)</small>, 5269 <small>(servers)</small>
* [Email](/email_fr): 25, 465 <small>(SMTP)</small>, 587 <small>(SMTP with SSL)</small>, 993 <small>(IMAP)</small>
<div class="alert alert-warning" markdown="1">
<span class="glyphicon glyphicon-warning-sign"></span> Certains fournisseurs d'accès internet / box internet imposent des contraintes sur certains ports. C'est le cas notamment du port 25 que seuls certains FAI permettent d'ouvrir. D'autres (e.g. SFR Red...) ne permettent pas d'utiliser librement les ports 80, 443 ou 22.
<span class="glyphicon glyphicon-warning-sign"></span> Certains fournisseurs d'accès internet bloquent le port 25 (mail SMTP) par défaut pour combattre le spam. D'autres (plus rares) ne permettent pas d'utiliser librement les ports 80/443. En fonction de votre FAI, il peut être possible d'ouvrir ces ports dans l'interface... Voir [cette page](isp_fr) pour plus d'informations.
</div>
## Redirection automatique / UPnP
---
#### UPnP
LUPnP permet douvrir automatiquement les ports. Si ce nest pas le cas par défaut, vous pouvez lactiver via linterface dadministration de votre routeur.
Dans certains cas après avoir changé la configuration de votre box (ex : sur Freebox ajout dIPv6, débloquer le SMTP…) et après lavoir rebooté. Il se peut que vos ports ne soient plus redirigés. Il faut donc réautoriser ces ports par le firewall :
Une technologie nommée UPnP est disponible sur certains routeurs/box et permet de rediriger automatiquement des ports vers une machine qui le demande. Si UPnP est activé chez vous, exécuter cette commande devrait automatiquement rediriger les bons ports :
```bash
sudo yunohost firewall reload
```
#### Redirection manuelle des ports
Dans le cas où lUPnP ne fonctionne pas, la redirection manuelle des ports est nécessaire. Encore une fois, référez-vous à linterface dadministration de votre routeur.
ATTENTION (CPU ARM) : lactivation de lUPnP est inefficace avec les serveurs équipés dun processeur ARM (remarque valable pour YunoHost v2.2). Une redirection manuelle des ports du routeur est alors requise.
#### Le courrier électronique
Les fournisseurs daccès à Internet bloquent souvent le port 25 pour éviter que les ordinateurs de votre réseau nenvoient des spams sur Internet à votre insu. Pour pouvoir envoyer des emails, il vous faut donc ouvrir le port 25, ou désactiver loption « blocage SMTP sortant » dans ladministration de votre routeur.

6
port_forwarding.md Normal file
View file

@ -0,0 +1,6 @@
# Port forwarding
The sketch below tries to briefly summarize the role and necessity of port
forwarding when setting up a server at home.
<img src="./images/portForwarding_en.png" width="100%">

6
port_forwarding_fr.md Normal file
View file

@ -0,0 +1,6 @@
# Redirection de ports
Le schéma ci-dessous tente d'expliquer brièvement le rôle de la redirection des
ports lors de la mise en place d'un serveur à la maison.
<img src="./images/portForwarding_fr.png" width="100%">