Merge branch 'master' of github.com:ivanilves/xiringuito

* 'master' of github.com:ivanilves/xiringuito:
  Update README.md
  Update README.md
  Update README.md
This commit is contained in:
Ivan Ilves 2017-02-23 20:04:33 +01:00
commit 52a89cba61

View File

@ -1,17 +1,17 @@
# xiringuito
*SSH-based VPN for poors*
*SSH-based VPN for poors* :wink:
VPN made easy! No configurations. No VPN servers. No hassle. **Just plug and use!**
VPN made easy! No configuration. No VPN servers. No hassle. **Just plug and use!**
This is the "VPN without VPN" software done using built-in capabilities of SSH.
This is the "VPN without VPN" software done using nice built-in capabilities of SSH.
## Install
### Install (just download it)
```
git clone https://github.com/ivanilves/xiringuito.git
```
## Use
### Use (just run it)
```
cd xiringuito
./xiringuito user@your.ssh.server 10.0.0.0/8 192.168.0.0/16
@ -19,9 +19,9 @@ cd xiringuito
Yes! That easy - just pass an SSH server and the list of networks your want to access through this server.
You will need:
* Linux or Mac system.
* Local sudo privileges.
* Remote sudo privileges.
* Linux or Mac system
* Local sudo privileges
* Remote sudo privileges
# Mac note
Install [TunTap for Mac OS X](http://tuntaposx.sourceforge.net/) first.