rudefox/tor-proxy
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated README.md docs

Browse Source
This commit is contained in:
B.J. Dweck 2022-01-05 09:59:57 +02:00
parent ff20e94032
commit 134c07ebdb
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -3,7 +3,15 @@ Tor Proxy
This is a Tor Proxy Docker container for "torifying" other Docker-based services in a Docker Compose project. It creates a Tor Hidden Service with an onion hostname that persists as long as it's underlying storage volume. The Tor Hidden Service listens on the specified port and proxies traffice to the specified target host:port. This is a Tor Proxy Docker container for "torifying" other Docker-based services in a Docker Compose project. It creates a Tor Hidden Service with an onion hostname that persists as long as it's underlying storage volume. The Tor Hidden Service listens on the specified port and proxies traffice to the specified target host:port.
### Example Usage ## Usage
### Arguments
- `SVC_LISTEN_PORT`: Port that the Tor hidden service will listen on for requests from the Tor network
- `SVC_TARGET_HOST`: Target host for Tor traffic
- `SVC_TARGET_PORT`: Target port on the target host
### Sample `docker-compose.yml`
`docker-compose.yml`: `docker-compose.yml`:
``` ```
@ -11,7 +19,7 @@ This is a Tor Proxy Docker container for "torifying" other Docker-based services
mysvc_tor_proxy: mysvc_tor_proxy:
build: build:
context: ./tor context: ./tor-proxy
args: args:
- SVC_LISTEN_PORT=80 - SVC_LISTEN_PORT=80
- SVC_TARGET_HOST=mysvc - SVC_TARGET_HOST=mysvc
@ -24,3 +32,11 @@ This is a Tor Proxy Docker container for "torifying" other Docker-based services
... ...
``` ```
### Service Onion Hostname
You can get the onion hostname of the proxy using the following command:
```
user@host:~$ docker-compose exec mysvc_tor_proxy svc-hostname
```