Update README

This commit is contained in:
Peter Dave Hello 2017-11-06 05:12:30 +08:00
parent a3a67eb244
commit b5a7344482

View file

@ -12,12 +12,16 @@ The super easy way to setup a tor SOCKS5 proxy server without relay/exit feature
$ docker run -d --name tor_socks_proxy -p 127.0.0.1:9150:9150 peterdavehello/tor-socks-proxy:latest
```
If you already setup the instance before*(not the first time)*, just start it:
- Use `127.0.0.1` to limit the connections from localhost, do not change it unless you know you're going to expose it to a local network or to the Internet.
- Change to first `9150` to any valia and free port you want, please note that port `9050`/`9150` may already taken if you are also running other Tor client, like TorBrowser.
- Do not touch the second `9150` as it's the port inside the docker container unless you're going to change the port in Dockerfile.
If you already setup the instance before *(not the first time)*, just start it:
```
$ docker start tor_socks_proxy
```
2. Make sure it's running
2. Make sure it's running, it'll take a short time to bootstrap
```
$ docker logs tor_socks_proxy
.
@ -29,13 +33,14 @@ The super easy way to setup a tor SOCKS5 proxy server without relay/exit feature
Jan 10 01:07:02.000 [notice] Bootstrapped 100%: Done
```
3. Configure your client to use it, target on `127.0.0.1` port `9150`
3. Configure your client to use it, target on `127.0.0.1` port `9150`(Or the other port you setup in step 1)
Take `curl` as an example, checkout what's your ip address via tor nextwork:
```sh
$ curl --socks5-hostname 127.0.0.1:9150 ipinfo.io/ip
$ curl --socks5-hostname 127.0.0.1:9150 icanhazip.com
$ curl --socks5-hostname 127.0.0.1:9150 ipecho.net/plain
$ curl --socks5-hostname 127.0.0.1:9150 whatismyip.akamai.com
```
Take `ssh` and `nc` as an example, connect to a host via tor:
@ -47,3 +52,5 @@ The super easy way to setup a tor SOCKS5 proxy server without relay/exit feature
```sh
$ docker stop tor_socks_proxy
```
For the project sustainability I strongly encourge you to help setup Tor bridge/exit and donate money to the Tor project (Not this proxy project) when you have the ability/capacity!