Update README file

This commit is contained in:
oblique 2013-12-04 15:39:01 +02:00
parent b39f4466de
commit 8bee5d61ba

View File

@ -1,46 +1,69 @@
## Dependencies
## Features
* Create an AP (Access Point) at any channel.
* Choose one of the following encryptions: WPA, WPA2, WPA/WPA2, Open (no encryption).
* Hide your SSID.
* Internet sharing methods: NATed or Bridged or None (no Internet sharing).
* Choose the AP Gateway IP (only for 'NATed' and 'None' Internet sharing methods).
* You can create an AP with the same interface you are getting your Internet connection.
* You can pass your SSID and password through pipe or through arguments (see examples).
## Dependencies
### General
* bash (to run this script)
* util-linux (for getopt)
* hostapd
* dnsmasq
* iptables
* iproute2
* iw
* haveged (optional)
### For 'nat' or 'none' Internet sharing method
* dnsmasq
* iptables
### For 'brigde' Internet sharing method
* bridge-utils
* dhclient
## Installation
###
git clone https://github.com/oblique/create_ap
cd create_ap
make install
## Examples
### No passphrase (open network):
./create_ap wlan0 eth0 MyAccessPoint
OR
echo -e "MyAccessPoint" | ./create_ap wlan0 eth0
create_ap wlan0 eth0 MyAccessPoint
### WPA + WPA2 passphrase:
./create_ap wlan0 eth0 MyAccessPoint MyPassPhrase
OR
echo -e "MyAccessPoint\nMyPassPhrase" | ./create_ap wlan0 eth0
create_ap wlan0 eth0 MyAccessPoint MyPassPhrase
### AP without Internet sharing:
create_ap -n wlan0 MyAccessPoint MyPassPhrase
./create_ap -n wlan0 MyAccessPoint MyPassPhrase
### Bridged Internet sharing:
create_ap -m bridge wlan0 eth0 MyAccessPoint MyPassPhrase
OR
### Internet sharing from the same WiFi interface:
create_ap wlan0 wlan0 MyAccessPoint MyPassPhrase
### No passphrase (open network) using pipe:
echo -e "MyAccessPoint" | create_ap wlan0 eth0
### WPA + WPA2 passphrase using pipe:
echo -e "MyAccessPoint\nMyPassPhrase" | create_ap wlan0 eth0
echo -e "MyAccessPoint\nMyPassPhrase" | ./create_ap -n wlan0
## Systemd service
Using the persistent [systemd](https://wiki.archlinux.org/index.php/systemd#Basic_systemctl_usage) service
### Install:
# cp create_ap.service /etc/systemd/system
### Start service immediately:
# systemctl start create_ap
systemctl start create_ap
### Start on boot:
# systemctl enable create_ap
systemctl enable create_ap
## License
FreeBSD