mirror of
https://github.com/YunoHost-Apps/hotspot_ynh.git
synced 2024-09-03 19:25:53 +02:00
Auto-update README
This commit is contained in:
Yunohost-Bot
Yunohost-Bot
parent
a004e18dad
commit
b7b826f0ca
2 changed files with 72 additions and 54 deletions
83
README.md
83
README.md
|
|
@ -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)*
|
||||
|
||||
> *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
|
||||
|
||||
|
||||
|
||||
## 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 - [](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/)
|
||||
|
||||
## Limitations
|
||||
|
||||
## Additional information
|
||||
## Screenshots
|
||||
|
||||
## 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.
|
||||
## 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
|
||||
43
README_fr.md
Normal file
43
README_fr.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# Wifi Hotspot pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/hotspot)  
|
||||
[](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
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
Loading…
Reference in a new issue