Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

specify python2 and add spacing #55

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

specify python2 and add spacing #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,29 @@
# Introduction

*Hotspotd* is a small daemon to create a wifi hotspot on linux. It depends on *hostapd* for AP provisioning and *dnsmasq* to assign IP addresses to devices.

Hotspotd works by creating a virtual NAT (Network address transation) table between your connected device and the internet using linux *iptables*.

# Installation

To install hotspotd, just follow these steps:

```
wget https://github.com/prahladyeri/hotspotd/raw/master/dist/hotspotd-latest.tar.gz
tar xvf hotspotd-latest.tar.gz
cd hotspotd-latest/
sudo python setup.py install
sudo python2 setup.py install
```

To uninstall hotspotd, just say:

```sudo python setup.py uninstall```
```sudo python2 setup.py uninstall```

# Dependencies

* *dnsmasq* (typically pre-installed on most linux distributions)
* *hostapd* for AP provisioning
* *python 2* (typically pre-installed on most linux distributions)

To install hostapd on ubuntu:

Expand Down Expand Up @@ -64,6 +69,7 @@ The first time you run hotspotd, it will ask you for configuration values for SS
* If the above output includes “mac80211” then it means your wifi card will support the AP mode.

# Testing status

This package has been tested on Qualcomm Atheros adapter on the following distros:

* Ubuntu 12.04 LTS
Expand All @@ -72,6 +78,7 @@ This package has been tested on Qualcomm Atheros adapter on the following distro
In theory, it should work with all other distros too (on machines having wifi adapters supported by hostapd), but you will have to try that out and tell me!

# Notes

* Replace `sudo` with `su` or `su -c` if you manage superuser access in that manner.
* PyPI home page could be found at https://pypi.python.org/pypi/hotspotd.
* I need someone to test this daemon across various linux distros. If you are interested in testing of open-source apps, please contact me.