Skip to content

Commit

Permalink
Update documentation for sockets
Browse files Browse the repository at this point in the history
  • Loading branch information
Christophe Mehay committed May 12, 2019
1 parent 4d76ed3 commit d666d38
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 8 deletions.
13 changes: 9 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ test:
tag:
git tag v$(TOR_VERSION) -f

release: test tag
git push origin --tags

check:
pre-commit run --all-files

Expand All @@ -19,10 +22,12 @@ rebuild:
docker-compose -f docker-compose.build.yml build --no-cache

run: build
docker-compose -f docker-compose-v1.yml up

docker-compose -f docker-compose-v1.yml up --force-recreate
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
docker-compose -f docker-compose.v3.yml up
docker-compose -f docker-compose.v3.yml up --force-recreate
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,14 @@ hello: 5azvyr7dvvr4cldn.onion:80, 5azvyr7dvvr4cldn.onion:800, 5azvyr7dvvr4cldn.o

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.

> **WARNING**: Using sockets and ports in the same service group can lead to issues

##### `{SERVICE}_TOR_SERVICE_VERSION`

Can be `2` or `3`. Set the tor address type.
Expand Down Expand Up @@ -154,7 +158,7 @@ This containner uses [`pytor`](https://github.com/cmehay/pytor) to mannages tor

# 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

Expand Down
4 changes: 2 additions & 2 deletions docker-compose.v2.socket.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ services:
links:
- world
environment:
# Set mapping port to unix socket
WORLD_PORTS: 80:unix:/var/run/nginx.sock
# Set service hosts to unix socket
WORLD_TOR_SERVICE_HOSTS: 80:unix://var/run/nginx.sock

# Mount socket directory from world container
volumes_from:
Expand Down

0 comments on commit d666d38

Please sign in to comment.