Browse Source

README

master
Robin Thoni 7 years ago
parent
commit
99aef78c40
1 changed files with 36 additions and 0 deletions
  1. 36
    0
      README.md

+ 36
- 0
README.md View File

@@ -0,0 +1,36 @@
1
+ap.py
2
+=====
3
+
4
+
5
+[ap.py](ap.py) is a wrapper for [create_ap.py](https://github.com/oblique/create_ap).
6
+It allows you to run a simple access point using a predefined configuration in different environments easily.
7
+
8
+
9
+Installation
10
+----------------
11
+
12
+Copy [default.conf](default.conf) to `/etc/create_ap/default.conf`
13
+You can edit [default.conf](default.conf) to match your needs. For a basic setup, just edit `SSID` and `PASSPHRASE`.
14
+`SHARE_METHOD`, `WIFI_IFACE` and `INTERNET_IFACE` fields will be overwritten at runtime with  [ap.py](ap.py) arguments.
15
+
16
+Additionally, you can copy [ap.py](ap.py) to your path (/usr/local/bin/ap, for example)
17
+
18
+
19
+Usage
20
+--------
21
+
22
+- Share your ethernet (eth0) network by forwarding requests (aka bridge) from your wireless interface (wlan0):
23
+`ap bridge wlan0 eth0`
24
+All requests done by a wireless device connected on wlan0 will be forwarded to your ethernet network. No need for local DHCP server.
25
+
26
+- Share your ethernet (eth0) network by rewriting requests (aka NAT) from your wireless interface (wlan0):
27
+`ap nat wlan0 eth0`
28
+All requests done by a wireless device connected on wlan0 will be rewritten and sent as if your computer sent them. A local DHCP server is needed but will be setup by [create_ap.py](https://github.com/oblique/create_ap).
29
+
30
+- Share your wireless network (wlan0) to another wireless interface (wlan1) (useful if your wireless network does not allow clients communication):
31
+`ap nat wlan1 wlan0`
32
+All requests done by a wireless device connected on wlan0 will be rewritten and sent as if your computer sent them. A local DHCP server is needed but will be setup by [create_ap.py](https://github.com/oblique/create_ap). **Please note that two wireless interfaces can not be bridged.**
33
+
34
+- Create an 'empty' wireless (wlan0) network without internet access (allow devices to comunicate to each other):
35
+`ap none wlan0`
36
+A local DHCP server is needed but will be setup by [create_ap.py](https://github.com/oblique/create_ap). 

Loading…
Cancel
Save