hotspot_ynh/README.md

# Wifi Hotspot
## Overview

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/labriqueinternet/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).

This YunoHost app is a part of the "[La Brique Internet](http://labriqueinter.net)" project but can be used independently.

## 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
* Web interface ([screenshot](https://raw.githubusercontent.com/labriqueinternet/hotspot_ynh/master/screenshot.png))

## Friendly apps

Some other YunoHost apps have this Hotspot wifi app as prerequisite, in order to offer a service through a wifi access point.

With a multissid wireless card (most can do that), you can create multiple access points.

For example, you can create 3 hotspots:

1. *PirateBox*
2. *torNetwork*
3. *neutralNetwork*

You can then install and configure 3 other dependent apps on your YunoHost:

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 Jessie
* YunoHost >= 2.2.0

**[BUG REPORTS SHOULD BE OPEN HERE](https://dev.yunohost.org)**
* 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: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).`
README - rename repo 2015-05-05 16:00:15 +02:00			`* With the [VPN Client app for YunoHost](https://github.com/labriqueinternet/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 2015-04-25 17:46:11 +02:00			`This YunoHost app is a part of the "[La Brique Internet](http://labriqueinter.net)" project but can be used independently.`
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)`
DHCP with dnsmasq 2014-12-26 18:58:58 +01:00			`* Announce DNS resolvers (IPv6 with RDNSS/DHCPv6 and IPv4 with DHCPv4)`
			`* Automatic clients configuration (IPv6 with SLAAC/DHCPv6 and IPv4 with DHCPv4)`
* 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`
README - rename repo 2015-05-05 16:00:15 +02:00			`* Web interface ([screenshot](https://raw.githubusercontent.com/labriqueinternet/hotspot_ynh/master/screenshot.png))`
Add Atheros AR9271 and AR7010 firmwares 2015-04-15 18:06:53 +02:00
Update README 2015-05-05 20:06:19 +02:00			`## Friendly apps`

			`Some other YunoHost apps have this Hotspot wifi app as prerequisite, in order to offer a service through a wifi access point.`

Update README 2015-05-05 20:08:12 +02:00			`With a multissid wireless card (most can do that), you can create multiple access points.`
Update README 2015-05-05 20:06:19 +02:00
			`For example, you can create 3 hotspots:`

			`1. PirateBox`
Update README 2015-05-05 20:08:12 +02:00			`2. torNetwork`
			`3. neutralNetwork`
Update README 2015-05-05 20:06:19 +02:00
			`You can then install and configure 3 other dependent apps on your YunoHost:`

doc: Fix Contribute link (update namespace) 2015-07-22 23:54:56 +02:00			`1. [PirateBox](https://github.com/labriqueinternet/piratebox_ynh) configured to use PirateBox,`
update README 2015-05-11 09:44:16 +02:00			`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.`
Update README 2015-05-05 20:06:19 +02:00
			`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.`

Add Atheros AR9271 and AR7010 firmwares 2015-04-15 18:06:53 +02:00			`## Prerequisites`

Ready for Jessie (+ some improvements) 2015-05-25 02:23:28 +02:00			`* Debian Jessie`
			`* YunoHost >= 2.2.0`
point to dev.yunohost.org in README 2015-11-28 15:19:47 +01:00
			`[BUG REPORTS SHOULD BE OPEN HERE](https://dev.yunohost.org)`