|
|
@@ -1,72 +1,47 @@
|
|
|
-# Wi-Fi Hotspot
|
|
|
+<!--
|
|
|
+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/hotspot_ynh)
|
|
|
-[](https://dash.yunohost.org/appci/app/hotspot)
|
|
|
-[](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.*
|
|
|
+[](https://dash.yunohost.org/appci/app/hotspot)  
|
|
|
+[](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)*
|
|
|
|
|
|
-## 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
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-## Demo
|
|
|
-
|
|
|
-## Configuration
|
|
|
+> *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.*
|
|
|
|
|
|
-## 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
|
|
|
-
|
|
|
-
|
|
|
-### Supported architectures
|
|
|
+## Overview
|
|
|
|
|
|
-* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/hotspot/)
|
|
|
-* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/hotspot/)
|
|
|
-* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/hotspot/)
|
|
|
+* 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
|
|
|
|
|
|
-## Limitations
|
|
|
|
|
|
-## Additional information
|
|
|
+**Shipped version:** 1.2.0~ynh6
|
|
|
|
|
|
-## Friendly apps
|
|
|
|
|
|
-Some other YunoHost apps have this Hotspot Wi-Fi app as prerequisite, in order to offer a service through a Wi-Fi access point.
|
|
|
|
|
|
-With a multissid wireless card (most can do that), you can create multiple access points.
|
|
|
+## Screenshots
|
|
|
|
|
|
-For example, you can create 3 hotspots:
|
|
|
+
|
|
|
|
|
|
-1. *PirateBox*
|
|
|
-2. *torNetwork*
|
|
|
-3. *neutralNetwork*
|
|
|
+## Documentation and resources
|
|
|
|
|
|
-You can then install and configure 3 other dependent apps on your YunoHost:
|
|
|
+* 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
|
|
|
|
|
|
-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.
|
|
|
+## Developer info
|
|
|
|
|
|
-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.
|
|
|
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/hotspot_ynh/tree/testing).
|
|
|
|
|
|
-## Prerequisites
|
|
|
+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
|
|
|
+```
|
|
|
|
|
|
-* Debian Stretch
|
|
|
-* YunoHost >= 3.2.0
|
|
|
+**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
Yunohost-Bot