Browse Source

Auto-update README

Yunohost-Bot 3 years ago
parent
commit
c721e9dec6
2 changed files with 70 additions and 29 deletions
  1. 30 29
      README.md
  2. 40 0
      README_fr.md

+ 30 - 29
README.md

@@ -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.
+-->
 
-[![Build Status](https://travis-ci.org/labriqueinternet/vpnclient_ynh.svg?branch=master)](https://travis-ci.org/labriqueinternet/vpnclient_ynh) [![Integration level](https://dash.yunohost.org/integration/vpnclient.svg)](https://dash.yunohost.org/appci/app/vpnclient)  
-[![Install LaBriqueInterNet VPNclient with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](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.
+[![Integration level](https://dash.yunohost.org/integration/vpnclient.svg)](https://dash.yunohost.org/appci/app/vpnclient) ![](https://ci-apps.yunohost.org/ci/badges/vpnclient.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/vpnclient.maintain.svg)  
+[![Install VPN Client with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](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
+![](./doc/screenshots/vpnclient.png)
 
-![Screenshot of the web interface](https://raw.githubusercontent.com/labriqueinternet/vpnclient_ynh/master/doc/screenshorts/vpnclient.png)
+## 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

+ 40 - 0
README_fr.md

@@ -0,0 +1,40 @@
+# VPN Client pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/vpnclient.svg)](https://dash.yunohost.org/appci/app/vpnclient) ![](https://ci-apps.yunohost.org/ci/badges/vpnclient.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/vpnclient.maintain.svg)  
+[![Installer VPN Client avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vpnclient)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer VPN Client rapidement et simplement sur un serveur YunoHost.
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
+
+## Vue d'ensemble
+
+Fait passer le trafic internet à travers un VPN
+
+**Version incluse :** 2.0~ynh1
+
+
+
+## Captures d'écran
+
+![](./doc/screenshots/vpnclient.png)
+
+## Documentations et ressources
+
+* Documentation YunoHost pour cette app : https://yunohost.org/app_vpnclient
+* Signaler un bug : https://github.com/YunoHost-Apps/vpnclient_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/vpnclient_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/vpnclient_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade vpnclient -u https://github.com/YunoHost-Apps/vpnclient_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps