YunoHost-Apps/hotspot_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/hotspot_ynh.git synced 2024-09-03 19:25:53 +02:00
Code Issues Activity Actions

Enhanced the README in accordance to YunoHost Apps README template

Browse source
This commit is contained in:
Julien Jershon 2019-10-19 10:01:39 +02:00
parent ec919eb58f
commit af2b7a678c
1 changed files with 26 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -1,8 +1,13 @@
# 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)
# 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)
This YunoHost app is a part of the "[La Brique Internet](http://labriqueinter.net)" project but can be used independently.
> *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.*
> This YunoHost app is a part of the "[La Brique Internet](http://labriqueinter.net)" project but can be used independently.
## Overview
@ -12,7 +17,17 @@ Hotspot Wi-Fi app for [YunoHost](http://yunohost.org/).
* 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).
## Features
## 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
@ -21,9 +36,15 @@ Hotspot Wi-Fi app for [YunoHost](http://yunohost.org/).
* 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
## Screenshot
### Supported architectures
![Screenshot of the web interface](https://raw.githubusercontent.com/labriqueinternet/hotspot_ynh/master/screenshot.png)
* 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
## Friendly apps
@ -49,4 +70,3 @@ In this manner, with this example, you can provide 3 access points at the same t
* Debian Stretch
* YunoHost >= 3.2.0