|
@@ -1,54 +1,40 @@
|
|
|
<!--
|
|
|
-N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
|
+N.B.: This README was automatically generated by <https://github.com/YunoHost/apps_tools/blob/main/readme_generator>
|
|
|
It shall NOT be edited by hand.
|
|
|
-->
|
|
|
|
|
|
-# VPN Client for YunoHost
|
|
|
+<h1>
|
|
|
+ <img src="https://raw.githubusercontent.com/YunoHost/apps/main/logos/vpnclient.png" width="32px" alt="Logo of VPN Client">
|
|
|
+ VPN Client, packaged for YunoHost
|
|
|
+</h1>
|
|
|
|
|
|
-[](https://ci-apps.yunohost.org/ci/apps/vpnclient/)
|
|
|
-
|
|
|
-
|
|
|
+Tunnel the internet traffic through a VPN
|
|
|
|
|
|
-[](https://install-app.yunohost.org/?app=vpnclient)
|
|
|
+[](https://labriqueinter.net)
|
|
|
+[?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/vpnclient/)
|
|
|
|
|
|
-*[Read this README in other languages.](./ALL_README.md)*
|
|
|
+<div align="center">
|
|
|
+<a href="https://apps.yunohost.org/app/vpnclient"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_more_info_on_the_appstore.svg"/></a>
|
|
|
+<a href="https://github.com/YunoHost-Apps/vpnclient_ynh/issues"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_report_an_issue.svg"/></a>
|
|
|
+</div>
|
|
|
|
|
|
-> *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.*
|
|
|
+## 📦 Developer info
|
|
|
|
|
|
-## Overview
|
|
|
+[](https://ci-apps.yunohost.org/ci/apps/vpnclient/)
|
|
|
|
|
|
-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.
|
|
|
+🛠️ Upstream VPN Client repository: <>
|
|
|
|
|
|
+Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/vpnclient_ynh/tree/testing).
|
|
|
|
|
|
+The `testing` branch can be tested using:
|
|
|
+```
|
|
|
+# fresh install:
|
|
|
+sudo yunohost app install https://github.com/YunoHost-Apps/vpnclient_ynh/tree/testing
|
|
|
|
|
|
-**Shipped version:** 2.2~ynh6
|
|
|
-
|
|
|
-## Screenshots
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-## Documentation and resources
|
|
|
-
|
|
|
-- Official app website: <https://labriqueinter.net>
|
|
|
-- YunoHost Store: <https://apps.yunohost.org/app/vpnclient>
|
|
|
-- Report a bug: <https://github.com/YunoHost-Apps/vpnclient_ynh/issues>
|
|
|
-
|
|
|
-## 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:
|
|
|
-
|
|
|
-```bash
|
|
|
-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
|
|
|
+# upgrade an existing install:
|
|
|
+sudo yunohost app upgrade vpnclient -u https://github.com/YunoHost-Apps/vpnclient_ynh/tree/testing
|
|
|
```
|
|
|
|
|
|
-**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
|
|
+### 📚 App packaging documentation
|
|
|
+
|
|
|
+Please see <https://doc.yunohost.org/packaging_apps> for more information.
|