Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zxt authored and zxt committed Sep 12, 2019
1 parent f97fa3c commit 329ad52
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Pangolin
# ![logo](imgs/logo.png?raw=true) Pangolin

Pangolin is a Go implenmentation of VPN.
* Support TCP/UDP/[PTCP](https://github.com/xitongsys/ptcp) connection. (I suggest PTCP, which has the same performance with UDP and avoid some UDP issues)
Expand All @@ -9,9 +9,7 @@ Pangolin is a Go implenmentation of VPN.
## Server
Pangolin server can only run natively on Linux. But you can use docker to run it on Windows and Mac.

* Download the latest release package.

* ```cd pangolin_linux/```
* Download the latest release package and ```cd pangolin_linux/```

* Change the environment variables in start.sh to your own.

Expand All @@ -22,15 +20,12 @@ TOKENS='["token01", "token02"]'
ROLE=SERVER
```

* Start the pangolin server.
```bash
bash start.sh
```
* Start the pangolin server: ```bash start.sh```

## Client

### Linux
Same steps with the server. But change the ```ROLE``` to ```CLIENT```.
Same steps with the server. But ```ROLE=CLIENT```.
```bash
SERVERIP=your.server.ip.address
SERVERPORT=12345
Expand All @@ -41,9 +36,13 @@ ROLE=CLIENT
### Windows
* [Windows Client](https://github.com/xitongsys/pangolin-win)

![Windows Client](imgs/win.png?raw=true)

### Android
* [Android Client](https://github.com/xitongsys/pangolin-android)

![Android Client](imgs/android.png?raw=true)

## Docker

### Build
Expand All @@ -58,10 +57,10 @@ TOKENS='["token01", "token02"]'
ROLE="SERVER"
```

* Build ```bash pangolin_docker.sh build```
* Build: ```bash pangolin_docker.sh build```


### Run/Stop
### Start/Stop
```bash
bash pangolin_docker.sh start
bash pangolin_docker.sh stop
Expand Down
Binary file added imgs/android.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added imgs/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed imgs/main.jpg
Binary file not shown.
Binary file added imgs/win.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 329ad52

Please sign in to comment.