|
@@ -1,43 +1,44 @@
|
|
|
-# VPN Client
|
|
|
+<!--
|
|
|
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
|
+It shall NOT be edited by hand.
|
|
|
+-->
|
|
|
|
|
|
-[](https://travis-ci.org/labriqueinternet/vpnclient_ynh) [](https://dash.yunohost.org/appci/app/vpnclient)
|
|
|
-[](https://install-app.yunohost.org/?app=vpnclient)
|
|
|
+# VPN Client for YunoHost
|
|
|
|
|
|
-This YunoHost app is a part of the "[La Brique Internet](http://labriqueinter.net)" project but can be used independently.
|
|
|
+[](https://dash.yunohost.org/appci/app/vpnclient)  
|
|
|
+[](https://install-app.yunohost.org/?app=vpnclient)
|
|
|
+
|
|
|
+*[Lire ce readme en français.](./README_fr.md)*
|
|
|
+
|
|
|
+> *This package allows you to install VPN Client quickly and simply on a YunoHost server.
|
|
|
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
-VPN Client app for [YunoHost](http://yunohost.org/).
|
|
|
+Tunnel the internet traffic through a VPN
|
|
|
+
|
|
|
+**Shipped version:** 2.0~ynh1
|
|
|
|
|
|
-* 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.
|
|
|
-* With the [Hotspot app for YunoHost](https://github.com/labriqueinternet/hotspot_ynh), you can broadcast your VPN access by wifi to use a clean internet connection (depending on your VPN provider) on your laptop (or those of your friends) without having to configure it.
|
|
|
|
|
|
-## Features
|
|
|
|
|
|
-* Authentication based on certificates or login (or both), with or without shared-secret (*ta.key*)
|
|
|
-* IPv6 compliant (with a delegated prefix)
|
|
|
-* Set an IPv6 from your delegated prefix (*prefix::42*) on the server, to use for the AAAA records
|
|
|
-* Use native IPv6 if available for creating the tunnel
|
|
|
-* Port selection, with UDP or TCP
|
|
|
-* Set DNS resolvers on the host
|
|
|
-* Strong firewalling (internet access and self-hosted services only available through the VPN)
|
|
|
-* Advanced mode for editing the default OpenVPN configuration
|
|
|
-* Auto-configuration mode, with [dot cube files](http://internetcu.be/dotcubefiles.html)
|
|
|
-and OVPN file with embeded certificates.
|
|
|
-* Web interface available from the web admin of YunoHost
|
|
|
+## Screenshots
|
|
|
|
|
|
-## Screenshot
|
|
|
+
|
|
|
|
|
|
-
|
|
|
+## Documentation and resources
|
|
|
|
|
|
+* YunoHost documentation for this app: https://yunohost.org/app_vpnclient
|
|
|
+* Report a bug: https://github.com/YunoHost-Apps/vpnclient_ynh/issues
|
|
|
|
|
|
-## Running vpnclient inside lxc
|
|
|
-If you want to run openvpn inside lxc, you should add this to your container:
|
|
|
+## Developer info
|
|
|
+
|
|
|
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/vpnclient_ynh/tree/testing).
|
|
|
+
|
|
|
+To try the testing branch, please proceed like that.
|
|
|
```
|
|
|
-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"
|
|
|
+sudo yunohost app install https://github.com/YunoHost-Apps/vpnclient_ynh/tree/testing --debug
|
|
|
+or
|
|
|
+sudo yunohost app upgrade vpnclient -u https://github.com/YunoHost-Apps/vpnclient_ynh/tree/testing --debug
|
|
|
```
|
|
|
+
|
|
|
+**More info regarding app packaging:** https://yunohost.org/packaging_apps
|