Browse Source

Auto-update README

Yunohost-Bot 3 years ago
parent
commit
0c30c3b3a8
2 changed files with 40 additions and 2 deletions
  1. 20 1
      README.md
  2. 20 1
      README_fr.md

+ 20 - 1
README.md

@@ -15,7 +15,22 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 
 ## Overview
 
-Tunnel the internet traffic through a VPN
+* Install a VPN connection on your self-hosted server.
+* Useful for hosting your server behind a filtered (and/or non-neutral) internet access.
+* Useful to have static IP addresses (IPv6 and IPv4).
+* Useful to easily move your server anywhere.
+* Strong firewalling (internet access and self-hosted services only available through the VPN, not leaking to your commercial ISP)
+* Combine with the [Hotspot app](https://github.com/YunoHost-Apps/hotspot_ynh) to broadcast VPN-protected WiFi to other laptops without any further technical configuration needed.
+
+## Running vpnclient inside lxc
+
+If you want to run openvpn inside lxc, you should add this to your container:
+```
+lxc.hook.autodev = sh -c "modprobe tun"
+lxc.mount.entry=/dev/net/tun dev/net/tun none bind,create=file
+lxc.hook.autodev = sh -c "chmod 0666 dev/net/tun"
+```
+
 
 **Shipped version:** 2.0~ynh1
 
@@ -25,6 +40,10 @@ Tunnel the internet traffic through a VPN
 
 ![](./doc/screenshots/vpnclient.png)
 
+## Disclaimers / important information
+
+Please note that this application is designed to interface with **dedicated, public IP VPNs accepting inbound traffic**, preferably with an associated `.cube` (or `.ovpn/.conf`) configuration file. **Do not** expect that any VPN you randomly bought on the Internet can be used! Checkout the [list of known compatible providers](https://yunohost.org/providers/vpn) for more info.
+
 ## Documentation and resources
 
 * YunoHost documentation for this app: https://yunohost.org/app_vpnclient

+ 20 - 1
README_fr.md

@@ -11,7 +11,22 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
 
 ## Vue d'ensemble
 
-Fait passer le trafic internet à travers un VPN
+* Installez une connexion VPN sur votre serveur auto-hébergé
+* Utile pour héberger votre serveur derrière un accès internet filtré (et/ou non-neutre)
+* Utile pour obtenir une IP statique (v4 et v6)
+* Utile pour pouvoir facilement déplacer votre serveur
+* Pare-feu strict (le traffice entrant et sortant se fait seulement via le pare-feu et ne fuite pas de données à votre FAI commercial)
+* Peut-être combiné avec [l'application Hotspot](https://github.com/YunoHost-Apps/hotspot_ynh) pour diffuser un WiFi protégé par le VPN à d'autres laptop sans configuration technique requise sur les machines clientes.
+
+## Faire tourner VPNclient dans un LXC
+
+Si vous souhaitez faire tourner OpenVPN dans un LXC, il vous faudra rajouter la configuration suivante dans votre conteneur:
+```
+lxc.hook.autodev = sh -c "modprobe tun"
+lxc.mount.entry=/dev/net/tun dev/net/tun none bind,create=file
+lxc.hook.autodev = sh -c "chmod 0666 dev/net/tun"
+```
+
 
 **Version incluse :** 2.0~ynh1
 
@@ -21,6 +36,10 @@ Fait passer le trafic internet à travers un VPN
 
 ![](./doc/screenshots/vpnclient.png)
 
+## Avertissements / informations importantes
+
+Notez que cette application est prévue pour fonctionner avec des **VPN dédiés et à IP publique qui acceptent le traffic entrant**, et de préférence avec un fichier de configuration `.cube` (ou `.ovpn/.conf`) associé. Un VPN acheté au hasard sur Internet ne fonctionnera sans doute pas ! Consultez [la liste des fournisseurs connus et compatibles](https://yunohost.org/providers/vpn) pour plus d'infos.
+
 ## Documentations et ressources
 
 * Documentation YunoHost pour cette app : https://yunohost.org/app_vpnclient