Skip to content

Commit

Permalink
Add chinese usage
Browse files Browse the repository at this point in the history
  • Loading branch information
boytm committed May 25, 2018
1 parent 2297154 commit 84e4e47
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@

# minivtun-win

[中文使用帮助](https://github.com/boytm/minivtun-win/wiki)

The minivtun is a tiny layer 3 vpn service on posix platform.
And this is a windows client for it.

No IPv6 tunnel and point-to-point mode due to limitation of driver
No IPv6 tunnel and point-to-point mode due to limitation of tap-windows driver

# Installation #

Expand All @@ -18,7 +22,11 @@ precompiled binary:

### Install required development components
python 2.7
python package: ipaddress pywin32 M2Crypto
python package: ipaddress pywin32 wmi M2Crypto

```cmd
python -m pip install -r requirements.txt
```

### Compile and pack
python setup.py py2exe
Expand All @@ -42,6 +50,8 @@ python setup.py py2exe

### Examples

Require administrator permission

Client: Connect VPN to the server (assuming address vpn.abc.com), with local virtual address 10.7.0.33, encryption with password "Hello":

python tun.py -r vpn.abc.com:1414 -a 10.7.0.33/24 -e Hello
Expand Down

0 comments on commit 84e4e47

Please sign in to comment.