Browse Source

Add proper DESCRIPTION.md

Alexandre Aubin 3 years ago
parent
commit
de285cdf8b
2 changed files with 30 additions and 0 deletions
  1. 15 0
      doc/DESCRIPTION.md
  2. 15 0
      doc/DESCRIPTION_fr.md

+ 15 - 0
doc/DESCRIPTION.md

@@ -0,0 +1,15 @@
+* 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"
+```

+ 15 - 0
doc/DESCRIPTION_fr.md

@@ -0,0 +1,15 @@
+* 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"
+```