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): Refine Mermaid diagrams and bump docs version

Browse Source 
- 🎨 Updated ARCHITECTURE.md diagrams with consistent string formatting
- 🔖 Incremented documentation version to 1.0.2
This commit is contained in:
rE-Bo0t.bx1
2025-11-14 20:28:57 +08:00
parent 74375d3af4
commit 942402fe89
1 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/ARCHITECTURE.md
View File

@@ -411,7 +411,7 @@ Security-critical whitelisting to prevent injection attacks:
flowchart TD
Start([🟢 OBFS4V Processing]) --> Enable{🔐 OBFS4_ENABLE_ADDITIONAL_VARIABLES?}
Enable -->|No| Skip([⏭️ Skip OBFS4V Processing])
Enable -->|Yes| GetVars[📥 env | grep '^OBFS4V_']
Enable -->|Yes| GetVars["📥 env | grep '^OBFS4V_'"]
GetVars --> Loop{🔁 For each OBFS4V_* var}
@@ -547,41 +547,41 @@ flowchart TD
```mermaid
graph TD
Root[/ 🗂️ Container Root ] --> Etc[/etc]
Root["🗂️ Container Root"] --> Etc[/etc]
Root --> Var[/var]
Root --> Run[/run]
Root --> Usr[/usr]
Root --> Sbin[/sbin]
Etc --> TorEtc[/etc/tor]
TorEtc --> TorRC[📝 torrc]
TorEtc --> TorRC["📝 torrc"]
TorEtc -.->|Deleted at build| TorRCSample[torrc.sample]
Var --> Lib[/var/lib]
Lib --> TorData[/var/lib/tor - VOLUME]
TorData --> Keys[🔑 keys/]
TorData --> FingerprintFile[🆔 fingerprint]
TorData --> PTState[🔐 pt_state/]
Lib --> TorData["/var/lib/tor - VOLUME"]
TorData --> Keys["🔑 keys/"]
TorData --> FingerprintFile["🆔 fingerprint"]
TorData --> PTState["🔐 pt_state/"]
Var --> Log[/var/log]
Log --> TorLog[/var/log/tor - VOLUME]
TorLog --> Notices[📄 notices.log]
Log --> TorLog["/var/log/tor - VOLUME"]
TorLog --> Notices["📄 notices.log"]
Run --> TorRun[/run/tor]
TorRun --> TorPID[📌 tor.pid]
TorRun --> TorPID["📌 tor.pid"]
Usr --> UsrLocal[/usr/local]
UsrLocal --> Bin[/usr/local/bin]
Bin --> Entrypoint[🚀 docker-entrypoint.sh]
Bin --> Healthcheck[🩺 healthcheck.sh]
Bin --> Status[📊 status]
Bin --> Health[📡 health]
Bin --> Fingerprint[🆔 fingerprint]
Bin --> BridgeLine[🌉 bridge-line]
Bin --> Entrypoint["🚀 docker-entrypoint.sh"]
Bin --> Healthcheck["🩺 healthcheck.sh"]
Bin --> Status["📊 status"]
Bin --> Health["📡 health"]
Bin --> Fingerprint["🆔 fingerprint"]
Bin --> BridgeLine["🌉 bridge-line"]
Usr --> UsrBin[/usr/bin]
UsrBin --> TorBin[🌀 tor]
UsrBin --> Lyrebird[🕊️ lyrebird]
UsrBin --> TorBin["🌀 tor"]
UsrBin --> Lyrebird["🕊️ lyrebird"]
Sbin --> Tini[/sbin/tini]
@@ -772,7 +772,7 @@ Docker `HEALTHCHECK` runs every 10 minutes:
```mermaid
flowchart TD
Start([⏱️ Health Check Timer]) -->|Every 10 min| Script[/usr/local/bin/healthcheck.sh]
Start([⏱️ Health Check Timer]) -->|Every 10 min| Script["usr/local/bin/healthcheck.sh"]
Script --> Check1{🌀 Tor process running?}
Check1 -->|No| Unhealthy1[❌ Exit 1: UNHEALTHY]
@@ -837,6 +837,6 @@ flowchart TD
---
**Document Version:** 1.0.1
**Document Version:** 1.0.2
**Last Updated:** 2025-01-14
**Container Version:** v1.1.1