hotspot_ynh/README.md

# Wifi Hotspot
## Overview

**Warning: work in progress**

Hotspot wifi app for [YunoHost](http://yunohost.org/).

* Broadcast your own Wifi 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/jvaubourg/vpnclient_ynh), it's an encrypted Wifi internet access (eventually with [neutral access](https://en.wikipedia.org/wiki/Net_neutrality), without filters, and with IPv6, depending on your VPN provider).

See the <a href="https://raw.githubusercontent.com/jvaubourg/hotspot_ynh/master/docs/box-project_french.pdf">box project</a> explanations (box for a ready-made and nomad self-hosting with YunoHost+VPN, a VPN access through a wifi hotspot, and/or a <a href="https://en.wikipedia.org/wiki/Customer-premises_equipment">CPE</a> for non-profit ISP) in French. An example of hardware associated is the <a href="https://www.olimex.com/Products/OLinuXino/A20/A20-OLinuXino-LIME/open-source-hardware">A20-OLinuXino-LIME</a> with the <a href="https://www.olimex.com/Products/USB-Modules/MOD-WIFI-R5370-ANT/">MOD-WIFI-R5370-ANT</a>. See also the <a href="https://github.com/bleuchtang/olinuxino-a20-lime">YunoHost image project</a> for OLinuXino.

## Features

* WPA2 encryption
* 802.11n compliant
* IPv6 compliant (with a delegated prefix)
* Automatic clients configuration (IPv6 and IPv4)
* Announce DNS resolvers (IPv6 and IPv4)
* Set an IPv6 from your delegated prefix (*prefix::42*) on the server, to use for the AAAA records
* Web interface ([screenshot](https://raw.githubusercontent.com/jvaubourg/hotspot_ynh/master/screenshot.png))
* Automatic detection of the interface * Automatic detection of wifi n * Checking inputs 2014-11-16 23:27:36 +01:00			`# Wifi Hotspot`
Fill README 2014-11-10 00:32:04 +01:00			`## Overview`
Initial commit 2014-11-02 13:02:55 +01:00
Fill README 2014-11-10 00:56:12 +01:00			`Warning: work in progress`

Fill README 2014-11-10 00:32:04 +01:00			`Hotspot wifi app for [YunoHost](http://yunohost.org/).`

			`* Broadcast your own Wifi internet access in addition to your self-hosted web services.`
			`* Without internet access, it's a [PirateBox](https://en.wikipedia.org/wiki/PirateBox).`
Fill README 2014-11-10 01:06:50 +01:00			`* With the [VPN Client app for YunoHost](https://github.com/jvaubourg/vpnclient_ynh), it's an encrypted Wifi internet access (eventually with [neutral access](https://en.wikipedia.org/wiki/Net_neutrality), without filters, and with IPv6, depending on your VPN provider).`
Fill README 2014-11-10 00:32:04 +01:00
Update README 2014-11-17 15:46:50 +01:00			See the <a href="https://raw.githubusercontent.com/jvaubourg/hotspot_ynh/master/docs/box-project_french.pdf">box project</a> explanations (box for a ready-made and nomad self-hosting with YunoHost+VPN, a VPN access through a wifi hotspot, and/or a <a href="https://en.wikipedia.org/wiki/Customer-premises_equipment">CPE</a> for non-profit ISP) in French. An example of hardware associated is the <a href="https://www.olimex.com/Products/OLinuXino/A20/A20-OLinuXino-LIME/open-source-hardware">A20-OLinuXino-LIME</a> with the <a href="https://www.olimex.com/Products/USB-Modules/MOD-WIFI-R5370-ANT/">MOD-WIFI-R5370-ANT</a>. See also the <a href="https://github.com/bleuchtang/olinuxino-a20-lime">YunoHost image project</a> for OLinuXino.
Add the box project docs and update TODO 2014-11-17 15:40:03 +01:00
Fill README 2014-11-10 00:32:04 +01:00			`## Features`

			`* WPA2 encryption`
* Automatic detection of the interface * Automatic detection of wifi n * Checking inputs 2014-11-16 23:27:36 +01:00			`* 802.11n compliant`
Some stuff 2014-11-10 22:27:59 +01:00			`* IPv6 compliant (with a delegated prefix)`
Fill README 2014-11-10 00:32:04 +01:00			`* Automatic clients configuration (IPv6 and IPv4)`
			`* Announce DNS resolvers (IPv6 and IPv4)`
* Automatic detection of the interface * Automatic detection of wifi n * Checking inputs 2014-11-16 23:27:36 +01:00			`* Set an IPv6 from your delegated prefix (prefix::42) on the server, to use for the AAAA records`
Fill README 2014-11-10 00:32:04 +01:00			`* Web interface ([screenshot](https://raw.githubusercontent.com/jvaubourg/hotspot_ynh/master/screenshot.png))`