github/tor-guard-relay
1
1
Fork 0
mirror of https://github.com/r3bo0tbx1/tor-guard-relay.git synced 2026-04-06 00:32:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

📝 docs(v1.1.1):

Browse Source 
- 📏 Corrected documented image size to 17.1 MB
- 🖼️ Updated all image references to r3bo0tbx1/onion-relay
- 🗂️ Standardized image naming across templates
- 🔐 Added security and privacy notes to the Code of Conduct
- 📚 Synced configuration notes for the v1.1.1 release
This commit is contained in:
rE-Bo0t.bx1
2025-11-14 03:29:22 +08:00
parent 3f0cf146f4
commit 05e7cf70cb
25 changed files with 59 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/BACKUP.md
View File

@@ -357,7 +357,7 @@ docker run -d \
-v tor-guard-data:/var/lib/tor \
-v tor-guard-logs:/var/log/tor \
--restart unless-stopped \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
# 6. Verify relay is using old identity
docker exec guard-relay fingerprint
@@ -456,7 +456,7 @@ docker run -d \
-v tor-guard-data:/var/lib/tor \
-v tor-guard-logs:/var/log/tor \
--restart unless-stopped \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
# 7. Verify startup and identity
docker logs -f guard-relay
@@ -516,7 +516,7 @@ docker run -d \
-v tor-guard-data:/var/lib/tor \
-v tor-guard-logs:/var/log/tor \
--restart unless-stopped \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
# 3. Verify NEW server is running
docker logs guard-relay | grep "Bootstrapped"

24
docs/DEPLOYMENT.md
View File

@@ -78,7 +78,7 @@ docker run -d \
-v tor-data:/var/lib/tor \
-v tor-logs:/var/log/tor \
--restart unless-stopped \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
```
### Step 4: Verify Deployment
@@ -288,7 +288,7 @@ version: '3.8'
services:
tor-relay:
image: ghcr.io/r3bo0tbx1/onion-relay:latest
image: r3bo0tbx1/onion-relay:latest
container_name: tor-relay
restart: unless-stopped
network_mode: host
@@ -338,7 +338,7 @@ docker run -d \
--network host \
-v ~/relay-guard.conf:/etc/tor/torrc:ro \
-v tor-data:/var/lib/tor \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
# With ENV variables
docker run -d \
@@ -350,7 +350,7 @@ docker run -d \
-e TOR_ORPORT=9001 \
-e TOR_DIRPORT=9030 \
-v tor-data:/var/lib/tor \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
```
### Exit Relay
@@ -362,7 +362,7 @@ docker run -d \
--network host \
-v ~/relay-exit.conf:/etc/tor/torrc:ro \
-v tor-data:/var/lib/tor \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
# With ENV variables
docker run -d \
@@ -375,7 +375,7 @@ docker run -d \
-e TOR_DIRPORT=9030 \
-e TOR_EXIT_POLICY="accept *:80,accept *:443,reject *:*" \
-v tor-data:/var/lib/tor \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
```
### Bridge Relay (obfs4)
@@ -387,7 +387,7 @@ docker run -d \
--network host \
-v ~/relay-bridge.conf:/etc/tor/torrc:ro \
-v tor-data:/var/lib/tor \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
# With ENV variables
docker run -d \
@@ -399,7 +399,7 @@ docker run -d \
-e TOR_ORPORT=9001 \
-e TOR_OBFS4_PORT=9002 \
-v tor-data:/var/lib/tor \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
# Get bridge line for sharing
docker exec tor-bridge bridge-line
@@ -447,7 +447,7 @@ version: '3.8'
services:
tor-relay:
image: ghcr.io/r3bo0tbx1/onion-relay:latest
image: r3bo0tbx1/onion-relay:latest
container_name: tor-relay
restart: unless-stopped
network_mode: host
@@ -475,7 +475,7 @@ version: '3.8'
services:
obfs4-bridge:
image: ghcr.io/r3bo0tbx1/onion-relay:latest
image: r3bo0tbx1/onion-relay:latest
container_name: obfs4-bridge
restart: unless-stopped
network_mode: host
@@ -507,7 +507,7 @@ docker ps | grep tor-relay
Expected output:
```
CONTAINER ID IMAGE STATUS
abc123def456 ghcr.io/r3bo0tbx1/onion-relay:latest Up 5 minutes (healthy)
abc123def456 r3bo0tbx1/onion-relay:latest Up 5 minutes (healthy)
```
### 2. Run Diagnostics
@@ -774,7 +774,7 @@ docker logs tor-relay --tail 50
# Validate configuration (if using mounted config)
docker run --rm \
-v ~/tor-relay/relay.conf:/etc/tor/torrc:ro \
ghcr.io/r3bo0tbx1/onion-relay:latest \
r3bo0tbx1/onion-relay:latest \
tor --verify-config -f /etc/tor/torrc
```

2
docs/LOCAL-TESTING.md
View File

@@ -279,7 +279,7 @@ After building locally:
- [ ] Diagnostic tools produce correct output
- [ ] Input validation catches invalid values
- [ ] OBFS4V_* whitelist blocks dangerous options
- [ ] Image size is ~20MB (`docker images localhost:5000/onion-relay:test`)
- [ ] Image size is ~17.1MB (`docker images localhost:5000/onion-relay:test`)
---

8
docs/MULTI-MODE.md
View File

@@ -111,7 +111,7 @@ docker run -d \
-e TOR_BANDWIDTH_BURST="100 MBytes" \
-v tor-guard-data:/var/lib/tor \
-v tor-guard-logs:/var/log/tor \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
```
### Docker Compose
@@ -121,7 +121,7 @@ version: '3.8'
services:
tor-guard-relay:
image: ghcr.io/r3bo0tbx1/onion-relay:latest
image: r3bo0tbx1/onion-relay:latest
container_name: tor-guard-relay
restart: unless-stopped
network_mode: host
@@ -192,7 +192,7 @@ docker run -d \
-e TOR_BANDWIDTH_BURST="100 MBytes" \
-v tor-exit-data:/var/lib/tor \
-v tor-exit-logs:/var/log/tor \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
```
### Exit Policy
@@ -256,7 +256,7 @@ docker run -d \
-e TOR_BANDWIDTH_BURST="20 MBytes" \
-v tor-bridge-data:/var/lib/tor \
-v tor-bridge-logs:/var/log/tor \
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
```
### Docker Compose

2
docs/PERFORMANCE.md
View File

@@ -606,7 +606,7 @@ docker exec guard-relay ulimit -n
docker run -d \
--ulimit nofile=65535:65535 \
# ... other options
ghcr.io/r3bo0tbx1/onion-relay:latest
r3bo0tbx1/onion-relay:latest
```
---