beenull/tor-socks-proxy
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Peter Dave Hello 2020-05-21 21:22:53 +08:00
parent fbd0be3467
commit 774ecfd79a
1 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -19,7 +19,7 @@ The super easy way to setup a [Tor](https://www.torproject.org) [SOCKS5](https:/
1. Setup the proxy server at the **first time** 1. Setup the proxy server at the **first time**
```sh ```sh
$ docker run -d --restart=always --name tor-socks-proxy -p 127.0.0.1:9150:9150 peterdavehello/tor-socks-proxy:latest $ docker run -d --restart=always --name tor-socks-proxy -p 127.0.0.1:9150:9150/tcp peterdavehello/tor-socks-proxy:latest
``` ```
- With parameter `--restart=always` the container will always start on daemon startup, which means it'll automatically start after system reboot. - With parameter `--restart=always` the container will always start on daemon startup, which means it'll automatically start after system reboot.
@ -27,6 +27,8 @@ The super easy way to setup a [Tor](https://www.torproject.org) [SOCKS5](https:/
- Change to first `9150` to any valid and free port you want, please note that port `9050`/`9150` may already taken if you are also running other Tor client, like TorBrowser. - Change to first `9150` to any valid 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. - 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 want to expose Tor's DNS port, also add `-p 127.0.0.1:53:53/udp` in the command, see [DNS over Tor](#dns-over-tor) for more details.
If you already setup the instance before *(not the first time)* but it's in stopped state, you can just start it instead of creating a new one: If you already setup the instance before *(not the first time)* but it's in stopped state, you can just start it instead of creating a new one:
```sh ```sh
@ -48,7 +50,7 @@ The super easy way to setup a [Tor](https://www.torproject.org) [SOCKS5](https:/
3. Configure your client to use it, target on `127.0.0.1` port `9150`(Or the other port you setup in step 1) 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 network: Take `curl` as an example, checkout what's your IP address via Tor network using one of the following IP checking services:
```sh ```sh
$ curl --socks5-hostname 127.0.0.1:9150 https://ipinfo.tw/ip $ curl --socks5-hostname 127.0.0.1:9150 https://ipinfo.tw/ip
@ -81,6 +83,18 @@ The super easy way to setup a [Tor](https://www.torproject.org) [SOCKS5](https:/
Just note that all the connections will be terminated and need to be reestablished. Just note that all the connections will be terminated and need to be reestablished.
## DNS over Tor
If you publish the DNS port in the first step of [Usage](#usage) section, you can query DNS request over Tor
This port only handles A, AAAA, and PTR requests, see details on [official manual](https://www.torproject.org/docs/tor-manual.html.en)
Set the DNS server to `127.0.0.1` (Or another IP you set), use [macvk/dnsleaktest](https://github.com/macvk/dnsleaktest) or go to one of the following DNS leaking test websites to verify the result:
- DNS leak test: <https://www.dnsleaktest.com>
- IP Leak Tests: <https://ipleak.org/>
- IP/DNS Detect: <https://ipleak.net/>
## Note ## Note
**For the Tor project sustainability, I strongly encourage you to help [setup Tor bridge/exit nodes](https://trac.torproject.org/projects/tor/wiki/TorRelayGuide)([**script**](https://github.com/PeterDaveHello/ubuntu-tor-simply-setup)) and [donate](https://donate.torproject.org/) money to the Tor project *(Not this proxy project)* when you have the ability/capacity!** **For the Tor project sustainability, I strongly encourage you to help [setup Tor bridge/exit nodes](https://trac.torproject.org/projects/tor/wiki/TorRelayGuide)([**script**](https://github.com/PeterDaveHello/ubuntu-tor-simply-setup)) and [donate](https://donate.torproject.org/) money to the Tor project *(Not this proxy project)* when you have the ability/capacity!**