diff --git a/README.md b/README.md index f24d77a..fd52412 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,47 @@ -# Wi-Fi Hotspot + -[![Build Status](https://travis-ci.org/labriqueinternet/hotspot_ynh.svg?branch=master)](https://travis-ci.org/labriqueinternet/hotspot_ynh) -[![Integration level](https://dash.yunohost.org/integration/hotspot.svg)](https://dash.yunohost.org/appci/app/hotspot) -[![Install LaBriqueInterNet Hotspot with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=hotspot) +# Wifi Hotspot for YunoHost -> *This package allows you to install DokuWiki quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +[![Integration level](https://dash.yunohost.org/integration/hotspot.svg)](https://dash.yunohost.org/appci/app/hotspot) ![](https://ci-apps.yunohost.org/ci/badges/hotspot.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hotspot.maintain.svg) +[![Install Wifi Hotspot with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hotspot) -> This YunoHost app is a part of the "[La Brique Internet](http://labriqueinter.net)" project but can be used independently. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Wifi Hotspot 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 -Hotspot Wi-Fi app for [YunoHost](http://yunohost.org/). -* Broadcast your own Wi-Fi internet access in addition to your self-hosted web services. -* Without internet access, it's a [PirateBox](https://en.wikipedia.org/wiki/PirateBox). -* With the [VPN Client app for YunoHost](https://github.com/labriqueinternet/vpnclient_ynh), it's an encrypted Wi-Fi internet access (eventually with [neutral access](https://en.wikipedia.org/wiki/Net_neutrality), without filters, and with IPv6, depending on your VPN provider). - -## Screenshot - -![Screenshot of the web interface](https://raw.githubusercontent.com/labriqueinternet/hotspot_ynh/master/screenshot.png) - -## Demo - -## Configuration - -## Documentation - -## YunoHost specific features - -* WPA2 encryption -* 802.11n compliant -* IPv6 compliant (with a delegated prefix) -* Announce DNS resolvers (IPv6 with RDNSS/DHCPv6 and IPv4 with DHCPv4) -* Automatic clients configuration (IPv6 with SLAAC/DHCPv6 and IPv4 with DHCPv4) -* Set an IPv6 from your delegated prefix (*prefix::42*) on the server, to use for the AAAA records +* Broadcast a Wi-Fi access point from your self-hosted server +* Combine with the [VPN Client app](https://github.com/labriqueinternet/vpnclient_ynh) to obtain a VPN-protected WiFi -### Supported architectures +**Shipped version:** 1.2.0~ynh6 -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/hotspot%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/hotspot/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/hotspot%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/hotspot/) -* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/hotspot%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/hotspot/) -## Limitations -## Additional information +## Screenshots -## Friendly apps +![](./doc/screenshots/hotspot.png) -Some other YunoHost apps have this Hotspot Wi-Fi app as prerequisite, in order to offer a service through a Wi-Fi access point. +## Documentation and resources -With a multissid wireless card (most can do that), you can create multiple access points. +* Official app website: https://internetcu.be/ +* YunoHost documentation for this app: https://yunohost.org/app_hotspot +* Report a bug: https://github.com/YunoHost-Apps/hotspot_ynh/issues -For example, you can create 3 hotspots: +## Developer info -1. *PirateBox* -2. *torNetwork* -3. *neutralNetwork* +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing). -You can then install and configure 3 other dependent apps on your YunoHost: +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug +or +sudo yunohost app upgrade hotspot -u https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug +``` -1. [PirateBox](https://github.com/labriqueinternet/piratebox_ynh) configured to use *PirateBox*, -2. [Tor Client](https://github.com/labriqueinternet/torclient_ynh/) configured to use *torNetwork*, -3. [VPN Client](https://github.com/labriqueinternet/vpnclient_ynh/) configured by default to use *neutralNetwork* because this hotspot is not used by another app in this case. - -In this manner, with this example, you can provide 3 access points at the same time with 3 different services and only one wireless card. - -## Prerequisites - -* Debian Stretch -* YunoHost >= 3.2.0 +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..f29303c --- /dev/null +++ b/README_fr.md @@ -0,0 +1,43 @@ +# Wifi Hotspot pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/hotspot.svg)](https://dash.yunohost.org/appci/app/hotspot) ![](https://ci-apps.yunohost.org/ci/badges/hotspot.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hotspot.maintain.svg) +[![Installer Wifi Hotspot avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hotspot) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Wifi Hotspot 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 + +* Diffusez un point d'accès Wi-Fi depuis votre serveur auto-hébergé +* À combiner avec l'[app VPN Client](https://github.com/labriqueinternet/vpnclient_ynh) pour obtenir un accès internet aumatiquement protégé par votre VPN + + +**Version incluse :** 1.2.0~ynh6 + + + +## Captures d'écran + +![](./doc/screenshots/hotspot.png) + +## Documentations et ressources + +* Site officiel de l'app : https://internetcu.be/ +* Documentation YunoHost pour cette app : https://yunohost.org/app_hotspot +* Signaler un bug : https://github.com/YunoHost-Apps/hotspot_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug +ou +sudo yunohost app upgrade hotspot -u https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file