mirror of
https://github.com/r3bo0tbx1/tor-guard-relay.git
synced 2026-04-06 00:32:04 +02:00
docs(v1.1.1): Update image references and documentation details
- 🖼️ Replaced onion.png with logo.png in README - 📁 Added logo.png to src/ directory - 📝 Updated quick start and configuration example references - 🔢 Corrected image size details from ~20MB to ~17.1MB in FAQ and security-validation-tests.sh
This commit is contained in:
@@ -10,7 +10,7 @@
|
||||
[](https://hub.docker.com/r/r3bo0tbx1/onion-relay)
|
||||
[](LICENSE.txt)
|
||||
|
||||
<img src="src/onion.png" alt="Onion diagram" width="400"/>
|
||||
<img src="src/logo.png" alt="Onion diagram" width="400"/>
|
||||
|
||||
**A hardened, production-ready Tor relay with built-in diagnostics and monitoring**
|
||||
|
||||
@@ -281,7 +281,7 @@ STATUS=$(echo "$HEALTH" | jq -r '.status')
|
||||
|
||||
### Getting Started
|
||||
- **[FAQ](docs/FAQ.md)** - ⭐ **NEW!** Frequently asked questions with factual answers
|
||||
- **[Quick Start Script](scripts/quick-start.sh)** - ⭐ **NEW!** Interactive relay deployment wizard
|
||||
- **[Quick Start Script](scripts/utilities/quick-start.sh)** - ⭐ **NEW!** Interactive relay deployment wizard
|
||||
- **[Migration Assistant](scripts/migration/migrate-from-official.sh)** - ⭐ **NEW!** Automated migration from thetorproject/obfs4-bridge
|
||||
- **[Deployment Guide](docs/DEPLOYMENT.md)** - Complete installation for Docker CLI, Compose, Cosmos Cloud, and Portainer
|
||||
- **[Migration Guide](docs/MIGRATION-V1.1.X.md)** - Upgrade to v1.1.1 or migrate from other Tor setups
|
||||
@@ -337,7 +337,7 @@ ORPort [::]:9001
|
||||
|
||||
Examples are found in the [`examples/`](examples/) directory for complete, annotated configuration files:
|
||||
|
||||
- **[relay.conf](examples/relay.conf)** - Recommended production config
|
||||
- **[relay-guard.conf](examples/relay-guard.conf)** - Recommended production config
|
||||
- Additional examples for specific use cases
|
||||
|
||||
> 📖 **Configuration help:** See [Deployment Guide](docs/DEPLOYMENT.md#configuration) for complete reference.
|
||||
|
||||
@@ -30,7 +30,7 @@ Built on Alpine Linux 3.22.2 with a minimal 20MB image size, busybox-only tools,
|
||||
|
||||
| Feature | This Project | Official Images |
|
||||
|---------|--------------|-----------------|
|
||||
| **Image size** | ~20 MB | ~100+ MB |
|
||||
| **Image size** | ~17.1 MB | ~100+ MB |
|
||||
| **Base** | Alpine 3.22.2 | Debian |
|
||||
| **Diagnostics** | 4 busybox tools + JSON API | None |
|
||||
| **Multi-mode** | Guard/Exit/Bridge in one image | Separate images |
|
||||
@@ -468,7 +468,7 @@ docker exec tor-relay fingerprint
|
||||
|
||||
**Security features:**
|
||||
- ✅ Non-root execution (tor user, UID 100, GID 101)
|
||||
- ✅ Ultra-minimal image (~20 MB, Alpine 3.22.2)
|
||||
- ✅ Ultra-minimal image (~17.1 MB, Alpine 3.22.2)
|
||||
- ✅ Busybox-only (no bash, python, or unnecessary binaries)
|
||||
- ✅ No exposed monitoring ports (diagnostics via `docker exec` only)
|
||||
- ✅ Weekly automated security rebuilds (Sundays 18:30 UTC)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/bin/sh
|
||||
# security-validation-tests.sh - Security validation for Tor Guard Relay v1.1.1
|
||||
# Tests security features of the ultra-optimized 20MB build
|
||||
# Tests security features of the ultra-optimized 17.1MB build
|
||||
|
||||
set -e
|
||||
|
||||
@@ -273,8 +273,8 @@ echo "Test 7: Documentation"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
|
||||
if [ -f README.md ]; then
|
||||
if grep -iq "20\s*MB\|~20MB" README.md; then
|
||||
test_pass "README mentions 20MB size"
|
||||
if grep -iq "20\s*MB\|~17.1MB" README.md; then
|
||||
test_pass "README mentions 17.1MB size"
|
||||
else
|
||||
test_warn "README doesn't mention optimized size"
|
||||
fi
|
||||
|
||||
BIN
src/logo.png
Normal file
BIN
src/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.9 MiB |
Reference in New Issue
Block a user