aniondev/torproxy repository overview

⁠TorProxy

⁠Purpose

TorProxy⁠ is a docker-image for running a hidden service in a docker-container.

The currently used Tor-version is 0.4.9.12-0+deb13u2.

⁠Usage

⁠Volumes

Using volumes is not required. There are 2 optional volumes:

• /var/log/tor
• /var/lib/tor/<hiddenservicename>

⁠Environment-variables

The following environment-variables are supported:

• hiddenservicedir
• hiddenserviceport
• hiddenserviceaddress
• lognotice
• logdebug

All of these environment-variables are required.

⁠Example

See docker-compose.example.yml⁠ for an example how to use this image.

⁠Additional stuff

After running this container, take a look at the tasks listed at community.torproject.org/relay/setup/post-install⁠.

⁠Development

⁠Development-state

⁠Branching-system

This repository applies the GitFlowSimplified⁠-branching-system.

⁠Image-properties

The image-build-artifacts of this repository implement the DefaultImageUsabilityRequirements⁠-branching-system.

⁠Project-Structure

This repository applies the CommonProjectStructure⁠-project-structure.

⁠Versioning-system

This repository applies the SemVerPractise⁠-versioning-system.

⁠License

See License.txt⁠ for license-information.