v/xiringuito
1
0
Fork 0
mirror of https://github.com/ivanilves/xiringuito.git synced 2025-05-28 04:50:23 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update README [skip ci]

Browse Source
This commit is contained in:
Ivan Ilves 2017-06-05 13:01:11 +02:00
parent d02f4b2a87
commit e4971621d2
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -13,11 +13,18 @@ This is the "VPN without VPN" software done using nice built-in capabilities of
git clone https://github.com/ivanilves/xiringuito.git
```
### Use (just run it)
### Use (just run it ...)
```
cd xiringuito
./xiringuito user@your.ssh.server 10.0.0.0/8 192.168.0.0/16
```
... or install it globally and run from any working directory:
```
cd xiringuito
sudo make install
xiringuito user@your.ssh.server 10.0.0.0/8 192.168.0.0/16
```
Yes! That easy - just pass an SSH server and the list of networks your want to access through this server.
You will need:
@ -25,6 +32,10 @@ You will need:
* Local sudo privileges
* Remote sudo privileges
## Xaval: connection manager
**NB!** To ease xiringuito configuration, `xaval` connection manager (script inside the project) could be used.
<img src="images/install.gif" />
## Mac note
Install [TunTap for Mac OS X](http://tuntaposx.sourceforge.net/) first.
@ -39,8 +50,5 @@ As long as your routes do not overlap, you can run as many `xiringuito` tunnels
<img src="images/xiringuito.png" width="256px" />
## Xaval: connection manager
**NB!** To ease xiringuito configuration `xaval` connection manager script (is inside the project) could be used.
## Future?
Before, due to lack of testing, we had some complications with adding new features and changing `xiringuito` behavior, but since **[this PR](https://github.com/ivanilves/xiringuito/pull/32)** was merged, we are covered and will bravely proceed with addressing **[issues](https://github.com/ivanilves/xiringuito/issues)** and any challenges on our way.