Skip to content

Commit

Permalink
Add note for tun/vpn mode inside docker
Browse files Browse the repository at this point in the history
Signed-off-by: Yilun <[email protected]>
  • Loading branch information
yilunzhang committed Nov 21, 2023
1 parent 4b35527 commit 1bcbf75
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,9 +222,9 @@ nConnect server side. You can get your client address using:
The address typically contains one or more dot, with the part after last dot
being your client public key.

### UDP support
### UDP mode

You can enable UDP support when starting nConnect server with tuna mode,
You can enable UDP when starting nConnect server with tuna mode

```shell
./nConnect -s --tuna --udp
Expand All @@ -236,9 +236,9 @@ You can also use nConnect as library. Please check [proxy_test.go](tests/proxy_t

### Use pre-built Docker image

*Pre-requirement*: Have working docker software installed. For help with that
*visit [official docker
*docs](https://docs.docker.com/install/#supported-platforms)
Pre-requirement: Have working docker software installed. For help with that
visit [official docker
docs](https://docs.docker.com/install/#supported-platforms)

We host the latest Docker image on our official Docker Hub account. You can get
it by
Expand All @@ -255,6 +255,10 @@ docker run --rm -it --net=host -v ${PWD}:/nConnect/data nknorg/nconnect

followed by the command line argument you want to add.

Note: If you are running nConnect in TUN or VPN mode inside Docker, you need to
be able to access TUN device inside Docker (e.g. `--cap-add=NET_ADMIN --device
/dev/net/tun:/dev/net/tun`).

## nConnect Client Connects to Multi Servers

Now nConnect client can connect to multi servers. You can edit `config.json` to add multi servers admin address:
Expand Down

0 comments on commit 1bcbf75

Please sign in to comment.