Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osminogin/docker-tor-simple
Simplest minimal container for Tor anonymity software based on Alpine
https://github.com/osminogin/docker-tor-simple
alpine anonymize docker docker-image docker-security docker-services minimalist socksv5 tor tor-anonymity tor-hidden-services tor-network tor-nodes tor-proxy tor-relay
Last synced: 2 days ago
JSON representation
Simplest minimal container for Tor anonymity software based on Alpine
- Host: GitHub
- URL: https://github.com/osminogin/docker-tor-simple
- Owner: osminogin
- License: mit
- Created: 2016-01-04T22:27:15.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-11T06:36:13.000Z (2 months ago)
- Last Synced: 2024-10-18T15:04:30.180Z (2 months ago)
- Topics: alpine, anonymize, docker, docker-image, docker-security, docker-services, minimalist, socksv5, tor, tor-anonymity, tor-hidden-services, tor-network, tor-nodes, tor-proxy, tor-relay
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/osminogin/tor-simple/
- Size: 58.6 KB
- Stars: 152
- Watchers: 6
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docker-tor-simple
[](https://github.com/osminogin/docker-tor-simple/actions?query=workflow%3A%22build+images%22) [](https://microbadger.com/images/osminogin/tor-simple) [](https://github.com/osminogin/docker-tor-simple/actions?query=workflow%3A%22latest+version%22) [](https://hub.docker.com/r/osminogin/tor-simple) [](https://microbadger.com/images/osminogin/tor-simple) [](https://github.com/osminogin/docker-tor-simple/blob/master/LICENSE)
**Smallest minimal docker container for Tor network proxy daemon.**
Suitable for relay, exit node or hidden service modes with SOCKSv5 proxy enabled. It works well as a single self-contained container or in cooperation with other containers (like `nginx`) for organizing complex hidden services on the Tor network.
The image is based on great Alpine Linux distribution so it is has extremely low size (about 8 MB).
Service uses latest available version of [Tor package](https://pkgs.alpinelinux.org/package/edge/community/x86_64/tor) from [Edge repo](https://wiki.alpinelinux.org/wiki/Edge).
## Port
* `9050` SOCKSv5 (without auth)
## Volumes
* `/var/lib/tor` data dir.
## Getting started
### Installation
Automated builds of the image are available on [Docker Hub](https://hub.docker.com/r/osminogin/tor-simple/) and is the recommended method of installation.
```bash
docker pull osminogin/tor-simple
```
Alternatively you can build the image yourself.
```bash
export PROJECT_NAME=tor-node # docker image name
make build DOCKER_IMAGE=$PROJECT_NAME
```
### Quickstart
```bash
export PROJECT_NAME=tor-local # changing default name
make build DOCKER_IMAGE=$PROJECT_NAME
make run
# or with docker-compose ...
docker-compose up
# or altenativly run docker directly ...
docker run --publish 127.0.0.1:9050:9050 -i $PROJECT_NAME
```
After start Tor proxy available on `localhost:9050`
**Warning! Don't bind SOCKSv5 port 9050 to public network addresses if you don't know exactly what you are doing (is much better bind to `localhost` as in the example above)**.
## Advanced usage
You can copy original tor config from container, modify and mount them back inside. Changing the configuration file is required for running Tor as exit node, relay or bridge. For some operation modes you need to expose additional ports (9001, 9030, 9051).
```bash
# Copy config from running container
docker cp tor:/etc/tor/torrc $HOME/torrc
# ... modify torrc and run again
# Start more complex example with updated config
docker run --rm --name tor \
--publish 127.0.0.1:9050:9050 \
--expose 9001 --publish 9001:9001 \ # ORPort
--expose 9030 --publish 9030:9030 \
--expose 9051 --publish 9051:9051 \
--volume $HOME/torrc:/etc/tor/torrc:ro \
osminogin/tor-simple
```
## Unit file for systemd
#### tor.service
```ini
[Unit]
Description=Tor service
Wants=network-online.target
Requires=docker.service
After=docker.service network.target network-online.target
[Service]
TimeoutStartSec=0
Restart=always
RestartSec=10s
ExecStartPre=/usr/bin/docker pull osminogin/tor-simple
ExecStart=/usr/bin/docker run --rm --name tor -p 127.0.0.1:9050:9050 osminogin/tor-simple
ExecStop=/usr/bin/docker stop tor
[Install]
WantedBy=multi-user.target
```
## Examples
Example webserver deployment config with microservice architecture to setup Tor hidden service.
#### docker-compose.yml
```yaml
version: '3.7'
services:
tor-node:
image: osminogin/tor-simple
restart: always
depends_on:
- nginx
nginx:
image: nginx
restart: always
```
## License
See [LICENSE](https://github.com/osminogin/docker-tor-simple/blob/master/LICENSE)