Commit Graph

44 Commits

Author SHA1 Message Date
rE-Bo0t.bx1
be4f2bc125 feat(v1.1.7): Happy Family support (Tor 0.4.9+ FamilyId)
🔧 New tool: gen-family - generate/view Happy Family keys
  - Supports --force flag to overwrite existing keys without backup prompt

🐳 Dockerfiles: gen-family in both Dockerfile and Dockerfile.edge

🔧 Entrypoint:
- Phase 2: detect *.secret_family_key, log found keys (informational only)
- Guard/exit config gen: append FamilyId + MyFamily from ENV vars
- Bridge intentionally excluded

📊 Status tool: show family key count + Happy Family config state

📚 Docs:
- README: Happy Family section (generate / import), persistence table, flowchart
- ARCHITECTURE: all mermaid diagrams updated (Phase 2, config gen, tools, dirs)
- TOOLS: full gen-family reference with examples and exit codes
- DEPLOYMENT, MIGRATION, MIGRATION-V1.1.X, TROUBLESHOOTING: 5 -> 6 tools
- FAQ, example configs: version bump + FamilyId/MyFamily placeholders
- Directory authority voting: how 9 dirauths vote on relay flags (5/9 consensus)
- CIISS v2 ContactInfo: field reference, generator link, proof:uri-rsa verification
- All TOR_CONTACT_INFO examples updated to CIISS v2 format across templates and docs

📋 Templates:
- Guard/exit/multi-relay compose: TOR_FAMILY_ID + TOR_MY_FAMILY env vars
- All cosmos-compose + docker-compose versions -> 1.1.7

👷 CI: validate.yml gen-family in 8 spots (threshold 6), security tests, quick-test

🛡️ SECURITY.md: 1.1.7 active, 1.1.6 maintenance, gen-family in tools list

🔖 Version bump 1.1.6 -> 1.1.7 across 30+ files, tool count 5 -> 6, CHANGELOG entry

No breaking changes. TOR_FAMILY_ID and TOR_MY_FAMILY are optional.
2026-03-02 16:23:10 +08:00
rE-Bo0t.bx1
90b65ee469 🔖 release(v1.1.6): bind mount fix, full repo audit, workflow fixes
🔧 Entrypoint:
- Detect wrong ownership on /var/lib/tor and /var/lib/tor/keys at startup
  with actionable chown commands before Tor fails cryptically in Phase 4
- Accept DEBUG=TRUE, DEBUG=1, DEBUG=yes (case-insensitive)
- Fix signal trap bug: inner cleanup_verify_tmp no longer overwrites
  the global TERM/INT handler (could skip graceful shutdown)

🛡️ Security:
- Deprecate all versions < v1.1.5 (CVE-2025-15467, OpenSSL CVSS 9.8)
- Add deprecation notice to README and SECURITY.md
- Update lifecycle tables in CHANGELOG and SECURITY

🐛 Bug Fixes:
- Fix bootstrap detection in migrate-from-official.sh
  (parsed non-existent "bootstrap_percent" field — now "bootstrap")
- Fix health JSON docs across 4 files: uptime_seconds → uptime,
  add missing pid/errors fields, correct reachable type to string
- Fix validate.yml: bash -n → sh -n (POSIX script, not bash)

📚 Documentation:
- Add "Bind Mount Ownership" troubleshooting section to README
- Fix chown 1000:1000 typo → 100:101 in TROUBLESHOOTING-BRIDGE-MIGRATION.md
- Add [1.1.6] changelog entry
- Update version references across 20+ files to v1.1.6
- Update 47x alpine:3.22.2 → 3.23.3 across migration docs/scripts
- Fix tool count 4 → 5 in DEPLOYMENT, ARCHITECTURE, TROUBLESHOOTING
- Remove 5 broken links (CLAUDE.md, CONTRIBUTORS.md, SECURITY-AUDIT-REPORT.md)
- Fix stale image tags (:1.1.1/:1.1.2 → :latest) in 4 files
- Rewrite PR template as clean reusable form

⚙️ Workflow (release.yml):
- Fix duplicate title in release body (name + body both had ## 🧅 header)
- Fix trailing --- not being stripped from changelog extract
- Fix Full Changelog link comparing current tag to itself
- Extract Alpine version from Dockerfile instead of hardcoding
- Add fetch-depth: 0 for git history in release-notes job
- Fix fallback commit range when no conventional commits found

🐳 Dockerfiles:
- Fix stale base.name label (alpine:3.23.0 → alpine:3.23.3)
- Fix trailing whitespace after backslash in Dockerfile.edge

📋 Templates:
- Update cosmos-compose and docker-compose versions to 1.1.6
2026-02-08 16:04:22 +05:30
rE-Bo0t.bx1
552c3148e8 feat(v1.1.5): security patch CVE-2025-15467 and build updates 2026-01-31 21:24:33 +05:30
rE-Bo0t.bx1
879084c11e 🐛 fix(docker): replace 'go get -u' and 'go mod tidy' with 'go mod download' for improved dependency management 2026-01-12 19:11:49 +08:00
rE-Bo0t.bx1
5120d0d0e9 feat(v1.1.4): modernize templates, security, and build variants
This update refines the Tor relay configuration and build process:
- Security: Disables DirPort and adopts ciissversion:2 for ContactInfo.
- Performance: Adds IPv6 support and hardware acceleration options.
- Builds: Establishes Stable vs. Edge variants for better testing cycles.
- Tooling: Integrates nyx.config and cleans up legacy tags.
- Sync: Aligns cosmos-compose and docker-compose templates.
- Update retention policy: Keep last 7 versions

No breaking changes introduced.
2025-12-21 03:14:39 +08:00
rE-Bo0t.bx1
bfad827af4 📝 docs: add Tor resources and reorganize deployment files
- 🧅 Add Tor Exit Router notice template for abuse handling
- ☁️ Add recommended hosting providers documentation
- ⚖️ Update LEGAL.md with the latest laws and policy changes
- 🚚 Move Docker and Cosmos compose files to their dedicated directories
2025-12-06 19:26:42 +08:00
rE-Bo0t.bx1
8c5977b0ff 📚 fix(readme): update tools count and Alpine version in documentation 2025-12-05 17:59:44 +08:00
rE-Bo0t.bx1
0f166d7c95 📚 fix(readme): update diagnostic tools count and Alpine base version 2025-12-05 04:56:12 +08:00
rE-Bo0t.bx1
a28ce0a4e6 feat: add gen-auth tool and refactor compose templates
Major refactor of Docker Compose configurations and tooling enhancements.

-  Add `gen-auth` script for generating Tor Control Port credentials
- 🐳 Refactor Docker Compose templates:
  - Add native healthcheck configurations to all relay/bridge files
  - Standardize security capabilities (drop ALL, add SETUID/SETGID)
  - Remove verbose comments to streamline template usage
  - Update volume definitions for better data persistence
- 🔧 Update base dependencies:
  - Alpine Linux -> 3.23.0
  - Golang -> 1.25.5-alpine
- 🧹 Standardize ENV variable names across all configurations
2025-12-05 04:37:19 +08:00
rE-Bo0t.bx1
bd86e906f4 📚 fix(docs): update image size references from 17.1 MB to 16.8 MB across documentation and scripts
- YEAH IT GOT EVEN SMALLER!!! 🪽
2025-11-21 00:29:59 +08:00
rE-Bo0t.bx1
9e222f7655 feat: enhance release workflow with manual controls
- 🎯 Add manual rebuild mode for on-demand package updates
- 🎛 Add variant selection (both/latest/edge)
- 📅 Separate rebuild schedules (weekly stable, 3-day edge)
-  Eliminate redundant edge rebuilds (~50% CI/CD reduction)
- 📝 Update documentation (README.md)
2025-11-19 14:40:04 +08:00
rE-Bo0t.bx1
47b486c977 feat(v1.1.2): Alpine edge variant, dual CI, GHCR edge builds 🚀
- Add Dockerfile.edge 🐚🔧
- Add stable and edge CI matrix 🔁📦
- GHCR edge-only deployment 🟣📤
- SBOMs for both variants 📜🔍
- Tests, screenshots, logo 🧪🖼️
- Update docs and PR template 📝
- Remove dependabot.yml 🗑️
2025-11-17 23:53:11 +08:00
rE-Bo0t.bx1
a94d409f2b feat(v1.1.2): Alpine edge variant, dual CI, GHCR edge builds 🚀
- Add Dockerfile.edge 🐚🔧
- Add stable and edge CI matrix 🔁📦
- GHCR edge-only deployment 🟣📤
- SBOMs for both variants 📜🔍
- Tests, screenshots, logo 🧪🖼️
- Update docs and PR template 📝
- Remove dependabot.yml 🗑️
2025-11-17 22:38:30 +08:00
rE-Bo0t.bx1
98a2e3f43b 📝 docs(v1.1.1): Update README acknowledgments 2025-11-16 00:38:54 +08:00
rE-Bo0t.bx1
e9b198081b 📝 docs(v1.1.1): Fix README
- 🪶 clarify light-weight info
2025-11-15 20:37:37 +08:00
rE-Bo0t.bx1
0b8b8da81a 📝 docs(v1.1.1): Add screenshots gallery to README
- 🔧 Updated README to show the 2x2 grid (fix title)
2025-11-15 19:56:05 +08:00
rE-Bo0t.bx1
d5ab1b4af1 📝 docs(v1.1.1): Add screenshots gallery to README
- 🖼️ Added Gallery section with four screenshots
- 📁 Added images to src/screenshots/
- 🔧 Updated README to show the 2x2 grid
- 🗂️ Synced documentation references
2025-11-15 19:44:11 +08:00
rE-Bo0t.bx1
3f47d8a7dc 📝 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
2025-11-15 18:21:13 +08:00
rE-Bo0t.bx1
1329507727 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
2025-11-15 18:09:39 +08:00
rE-Bo0t.bx1
f7a9ed9bd4 📝 docs(v1.1.1): Add Cosmos config templates and clarify docs
- 🧩 Added two JSON templates for Cosmos deployments:
  - Tor Guard Relay config template
  - obfs4 Bridge Relay config template
- 📘 Updated README.md to include configuration examples, network-mode guidance, and improved formatting
- 🔒 Revised SECURITY.md to clarify security considerations and correct inaccuracies
-  Fixed minor typos and improved example consistency
2025-11-14 22:48:21 +08:00
rE-Bo0t.bx1
4e088c8015 📝 docs(v1.1.1): Add flowchart to README and update architecture docs
- 🖼️ Added a detailed Mermaid flowchart to README.md to illustrate:
  - Container initialization
  - Relay mode selection
  - Operations
  - Shutdown
- 📉 Updated ARCHITECTURE.md to reduce image size from ~20 MB to ~17.1 MB
- ✏️ Made minor formatting improvements in README.md for clarity
2025-11-14 22:09:54 +08:00
rE-Bo0t.bx1
d60d0c1459 📝 docs(v1.1.1): Refine README and architecture docs formatting
- 📚 Removed excessive inline styles and container divs from README.md
- 🎨 Updated ARCHITECTURE.md diagrams with consistent string formatting
- 🔖 Incremented documentation version to 1.0.3
2025-11-14 21:36:30 +08:00
rE-Bo0t.bx1
4212aa233a 📝 docs(v1.1.1): Documentation, templates, and CI/CD enhancements
- 📘 Added comprehensive docs including FAQ, architecture, and migration guides
- 🧩 Introduced new and updated example configs and templates
- 🧾 Added a pull request template for contributor workflow
- 🧪 Enhanced CI/CD with SBOM generation and improved release notes
- 🛡️ Expanded Trivy security scanning coverage in pipelines
- 🔗 Updated README to reference new docs and the quick start script
2025-11-14 16:42:52 +08:00
rE-Bo0t.bx1
1b5ddce02a 📝 docs(v1.1.1): Documentation consistency updates
- 📏 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
2025-11-14 05:50:43 +08:00
rE-Bo0t.bx1
086c21bf8f 📝 docs(v1.1.1): Cyber dark README update
- 🎨 Applied full cyber dark theme with neon headers and panel styling
- 🧩 Reorganized sections for better readability and navigation
- 📘 Added upgraded formatting for diagnostic, monitoring, and deployment areas
- 🧱 Improved visual consistency across examples, tables, and code blocks
-  Updated badges and layout for a cleaner top section
2025-11-14 04:48:59 +08:00
rE-Bo0t.bx1
05e7cf70cb 📝 docs(v1.1.1):
- 📏 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
2025-11-14 03:33:01 +08:00
rE-Bo0t.bx1
9ed70bdb89 v1.1.1 Security Hardening & Config Enhancement 🛡️
🚀 Major architectural release with a near full rewrite of the entrypoint, validation system, diagnostics, and templates. The image is now ~20MB, fully busybox based, more secure, and more flexible for relay and bridge operators.

🔧 Critical Fixes
- Busybox compatible rewrite of OBFS4V_* parsing for values with spaces.
- Rewritten TOR_CONTACT_INFO validation to prevent crash loops.
- Restored bootstrap logs with Log notice stdout.
- Fixed ENV healthchecks and validation order.
- Resolved busybox regex and quoting issues across the script.

 Features and Enhancements
- Added PT_PORT with complete obfs4 bridge compatibility.
- Support for OR_PORT, PT_PORT, EMAIL, and NICKNAME.
- Rewritten bandwidth logic with correct Rate and Burst translation.
- Unified guard, exit, and bridge via TOR_RELAY_MODE.
- Integrated obfs4 with rewritten diagnostics for status, health, fingerprint, and bridge-line.
- Reliable ENV only mode without torrc files.

📦 Build Improvements
- Image reduced ~45MB to ~20MB with busybox only tools.
- Rewritten healthcheck for ENV and mounted configs.
- Four diagnostic tools rewritten to pure busybox sh.
- Weekly rebuilds with latest Alpine and Tor.

📚 Templates and Documentation
- All templates rewritten and updated with bandwidth options and naming alternatives.
- Updated Cosmos and Docker Compose templates for bridge, guard, exit.
- New templates README with full deployment, migration, and config comparisons.
- Revised Claude file with clearer differences and bandwidth notes.

🔒 Security Hardening
- 32 vulnerabilities fixed across critical, high, medium, low categories.
- Non root runtime with UID 100.
- Strict OBFS4V_* whitelist and rewritten validation.
- No exposed diagnostics ports, docker exec only.
- Smaller attack surface with removed binaries.

🚀 Migration Notes
- From v1.1.0: direct upgrade, no config changes, fingerprint preserved.
- From official obfs4 bridge: one time UID fix required, full ENV compatibility afterward.
- Templates include both TOR_ and official naming for smooth migration.

🧩 Compatibility
- Alpine 3.22.2 base, latest Tor from edge.
- AMD64 and ARM64 supported.
- Works with Docker, Compose, Cosmos Cloud, Portainer.
2025-11-14 02:08:27 +08:00
rE-Bo0t.bx1
e2a9b4d398 🚀 feat: Release v1.1.0
Bumped version to v1.1.0 across all project files.

🏗️ Infrastructure & Templates:
- 🐳 Docker Compose: Enhanced security, added persistent volume support.
- 📋 Cosmos templates: Updated with new environment variable defaults.

🛠️ Scripts:
- dashboard.sh: Implemented API token authentication, improved error handling, and added a notification UI.
- fingerprint.sh: Refactored for clearer output formatting, robust validation, and a comprehensive help message.

 General:
- Improved configuration management, health checks, and monitoring integration.
2025-11-08 00:00:49 +08:00
rE-Bo0t.bx1
97737d5ba8 🔧 v1.0.9 — Shell polish and log formatting improvements
- Fixed “sh: bad number” errors in status output
- Compact single-line stats in view-logs
- Improved numeric parsing and input sanitization
- Unified timestamp format and safer defaults
2025-11-07 02:31:47 +08:00
rE-Bo0t.bx1
47db82782f 🧱 chore(release): bump version to 1.0.8
- Added dynamic Unreleased compare link for changelog auto-updates
- Improved versioning automation and tagging safety
- Fixed newline warning in dependabot.yml
- Unified workflow timezone (Asia/Tokyo) and metadata consistency
- Updated CHANGELOG and docs for v1.0.8
2025-11-06 23:42:39 +08:00
rE-Bo0t.bx1
9c941b2ed3 🧠 chore: prepare v1.0.7 – smarter automation, Renovate integration, and CI/CD polish
- 🧹 Removed obsolete .github/release.yml in favor of unified Build workflow
- ⚙️ Updated workflow schedules (Asia/Tokyo timezone) for consistency
- 🧪 Removed redundant validation job and improved release resilience
- 📜 Enhanced changelog extraction and release note clarity
- 🐳 Refined Docker tagging logic to ensure latest always points to newest stable
- 🤖 Added Renovate configuration for Alpine apk pinning (<3.23.0 safety)
- 🔧 Introduced centralized changelog config for structured release notes
- 📖 Updated README and CHANGELOG to reflect v1.0.7 improvements
2025-11-06 23:03:26 +08:00
rE-Bo0t.bx1
e059cbc6e6 fix(📚 readme): update version numbers to v1.0.5 in diagnostic tools and documentation sections 2025-11-06 19:48:42 +08:00
rE-Bo0t.bx1
8786ccf3c7 fix(📚 readme): update badge labels and add container registry information 2025-11-06 19:44:37 +08:00
rE-Bo0t.bx1
25fd7a09d7 feat(security): enforce localhost-only binding for internal services (v1.0.2)
BREAKING CHANGE: Internal services now bind to 127.0.0.1 by default

This release enforces strict port security with a two-tier model:
- Public: 9001 (ORPort), 9030 (DirPort)
- Internal: 9035+ (metrics, health, dashboard) - localhost-only

Changes:
- CHANGELOG.md: Updated version entries, aligned to v1.0.2
- README.md: Updated version references and deployment examples
- SECURITY.md: Enhanced with network architecture and port policy
- relay-status.sh: Added port security validation (v1.0.2)
- integration-check.sh: Added port/version validation phases (v1.0.2)

Security Improvements:
- Prevents unauthorized external access to internal endpoints
- Adds reverse proxy, SSH tunnel, and VPN access guidance
- Includes comprehensive migration guide for existing deployments
- Adds automated security validation in diagnostic tools

Migration Required:
If accessing metrics/health externally, use reverse proxy with auth,
SSH tunneling, or VPN. See SECURITY.md for details.

Version: 1.0.2
2025-11-05 21:28:55 +08:00
rE-Bo0t.bx1
5e70cf0b2d 📚 docs(readme): clean up badges 2025-11-05 21:28:54 +08:00
rE-Bo0t.bx1
f864c18900 📚 docs(readme): clean up badges 2025-11-05 21:28:54 +08:00
rE-Bo0t.bx1
95165aae95 feat: v1.1 repository restructuring
Reorganize into professional directory structure:
- Add 6 comprehensive documentation files
- Update Dependabot configuration
- Update README for better navigation
- Create docs/, templates/, tools/, .github/ structure

See RESTRUCTURING-SUMMARY.md for complete details.

BREAKING CHANGES: None - fully backward compatible
2025-11-05 21:28:10 +08:00
rE-Bo0t.bx1
bc5644ccc4 📚 docs(readme): Add AnonPay donation links 👤🔗 2025-11-01 10:13:17 +09:00
rE-Bo0t.bx1
4e9e2ab352 📚 docs(readme): Update 📈 history chart link 2025-11-01 09:39:20 +09:00
rE-Bo0t.bx1
4991edb507 📚 docs(readme): Add support and donation section 2025-11-01 09:21:32 +09:00
rE-Bo0t.bx1
a8cac16a59 📚 docs(readme): clean up badges 2025-11-01 08:22:38 +09:00
rE-Bo0t.bx1
8057249f58 📚 docs(readme): clean up badges and workflow names for better visuals 2025-11-01 08:14:29 +09:00
rE-Bo0t.bx1
9f967de239 🐋 refactor: replace onion.container with Dockerfile for improved build process 2025-11-01 07:33:03 +09:00
rE-Bo0t.bx1
b06d2eb68f 🎉 Initial release - Tor Guard Relay v1.0 2025-11-01 07:15:32 +09:00