Skip to content

Commit

Permalink
update: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
codekow committed Nov 5, 2023
1 parent f37fb04 commit 5819dd3
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<h1 align="center"><b>tor-docker</b></h1>

# tor-docker

[![Build multiarch image - latest](https://github.com/bugfest/tor-docker/actions/workflows/main.yml/badge.svg)](https://github.com/bugfest/tor-docker/actions/workflows/main.yml)
[![Build multiarch image - tag](https://github.com/bugfest/tor-docker/actions/workflows/main-tag.yml/badge.svg)](https://github.com/bugfest/tor-docker/actions/workflows/main-tag.yml)

`Tor` daemon (https://www.torproject.org/download/tor/) multiarch container.
`Tor` daemon multiarch container.

Additional transport plugins included in the image:

- `obfs4proxy`

Tested architectures:
Expand All @@ -16,18 +16,24 @@ Tested architectures:
- `arm64`

Source code:

- https://gitlab.torproject.org/tpo/core/tor
- https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/obfs4
- https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/lyrebird

Downloads:

- https://www.torproject.org/download/tor

Used by:

- [bugfest/tor-controller](https://github.com/bugfest/tor-controller)

# Tor
## Tor

Tor is an anonymity network that provides:

- privacy
- enhanced tamperproofing
- enhanced tamper proofing
- freedom from network surveillance
- NAT traversal

Expand All @@ -51,7 +57,7 @@ WARNING: some Tor features might be missing, depending on the [Alpine community
make quick
```

# Usage
## Usage

```shell
docker pull quay.io/bugfest/tor
Expand Down

0 comments on commit 5819dd3

Please sign in to comment.