luckyimnotanigger/docker-tor-hidden-service
1
0
Fork 0
mirror of https://github.com/cmehay/docker-tor-hidden-service.git synced 2025-04-20 13:59:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #25 from cmehay/doc

Browse source 
Update documentation for sockets
This commit is contained in:
Christophe Mehay 2019-05-12 14:47:45 +02:00 • committed by GitHub
commit ec6f15761b
3 changed files with 17 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
Makefile
View file

@ -8,6 +8,9 @@ test:
tag: tag:
git tag v$(TOR_VERSION) -f git tag v$(TOR_VERSION) -f
release: test tag
git push origin --tags
check: check:
pre-commit run --all-files pre-commit run --all-files
@ -19,10 +22,12 @@ rebuild:
docker-compose -f docker-compose.build.yml build --no-cache docker-compose -f docker-compose.build.yml build --no-cache
run: build run: build
docker-compose -f docker-compose-v1.yml up docker-compose -f docker-compose-v1.yml up --force-recreate
run-v2: build run-v2: build
docker-compose -f docker-compose.v2.yml up docker-compose -f docker-compose.v2.yml up --force-recreate
run-v2-socket: build
docker-compose -f docker-compose.v2.socket.yml up --force-recreate
run-v3: build run-v3: build
docker-compose -f docker-compose.v3.yml up docker-compose -f docker-compose.v3.yml up --force-recreate

8
README.md
View file

@ -73,10 +73,14 @@ hello: 5azvyr7dvvr4cldn.onion:80, 5azvyr7dvvr4cldn.onion:800, 5azvyr7dvvr4cldn.o
The config patern for this variable is: `{exposed_port}:{hostname}:{port}}` The config patern for this variable is: `{exposed_port}:{hostname}:{port}}`
For example `80:hello:8080` will expose a onion service on port 80 to the port 8080 of hello hostname. For example `80:hello:8080` will expose an onion service on port 80 to the port 8080 of hello hostname.
Unix sockets are supported too, `80:unix://path/to/socket.sock` will expose an onion service on port 80 to the socket `/path/to/socket.sock`. See `docker-compose.v2.socket.yml` for an example.
You can concatenate services using comas. You can concatenate services using comas.
> **WARNING**: Using sockets and ports in the same service group can lead to issues
##### `{SERVICE}_TOR_SERVICE_VERSION` ##### `{SERVICE}_TOR_SERVICE_VERSION`
Can be `2` or `3`. Set the tor address type. Can be `2` or `3`. Set the tor address type.
@ -154,7 +158,7 @@ This containner uses [`pytor`](https://github.com/cmehay/pytor) to mannages tor
# Legacy deprecated doc # Legacy deprecated doc
ALL THE DOC BELLOW IS LEGACY, IT'S STILL WORKING BUT IT'S NOT RECOMMENDED ANYMORE AND COULD BE DROPPED IN FUTURE RELEASES. > **WARNING**: ALL THE DOC BELLOW IS LEGACY, IT'S STILL WORKING BUT IT'S NOT RECOMMENDED ANYMORE AND COULD BE DROPPED IN FUTURE RELEASES.
### Create a tor hidden service with a link ### Create a tor hidden service with a link

4
docker-compose.v2.socket.yml
View file

@ -9,8 +9,8 @@ services:
links: links:
- world - world
environment: environment:
# Set mapping port to unix socket # Set service hosts to unix socket
WORLD_PORTS: 80:unix:/var/run/nginx.sock WORLD_TOR_SERVICE_HOSTS: 80:unix://var/run/nginx.sock
# Mount socket directory from world container # Mount socket directory from world container
volumes_from: volumes_from: