Skip to content

docs: Simplify Guardian README, direct advanced users to Fortress#173

Merged
homepods merged 2 commits intomainfrom
claude/enhance-guardian-threat-detection-01W33gtXRC7vHbyCbyKqjpTa
Dec 6, 2025
Merged

docs: Simplify Guardian README, direct advanced users to Fortress#173
homepods merged 2 commits intomainfrom
claude/enhance-guardian-threat-detection-01W33gtXRC7vHbyCbyKqjpTa

Conversation

@homepods
Copy link
Copy Markdown
Member

@homepods homepods commented Dec 6, 2025

Pull Request

πŸ“‹ Description

Brief summary of changes:

Related Issue:

Fixes #

🎯 Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Security enhancement
  • Infrastructure/CI improvement
  • Refactoring (no functional changes)

πŸ”§ Component(s) Affected

  • Deployment scripts (setup.sh, uninstall.sh, network-config.sh)
  • Security features (Qsecbit, WAF, IDS/IPS)
  • Networking (VXLAN, OVS, OpenFlow)
  • Containers/PODs
  • Monitoring (Grafana, VictoriaMetrics)
  • n8n automation (POD 008)
  • LTE/5G connectivity
  • Documentation
  • Testing infrastructure
  • Other:

πŸ§ͺ Testing Done

How was this tested?

  • Fresh deployment test (./setup.sh in clean environment)
  • Uninstall test (./uninstall.sh verifies complete cleanup)
  • Service functionality tests
  • Network isolation tests
  • Security regression tests
  • Manual testing only
  • Automated tests added/updated

Test environment:

  • OS:
  • Podman version:
  • Hardware:

Test results:

# Paste relevant test output

βœ… Checklist

Before submitting this PR:

  • I have read CONTRIBUTING.md
  • My code follows the project's coding standards
  • I have tested my changes in a clean environment
  • I have updated documentation (README.md, CLAUDE.md, etc.)
  • I have checked for exposed secrets/credentials
  • My commit messages follow the conventional commits format
  • I have run shellcheck on bash scripts (if applicable)
  • I have run linting on Python code (if applicable)
  • All deployment scripts still work after my changes
  • I have verified network ranges are correct (10.200.x.x)

Security considerations:

  • No hardcoded credentials added
  • No security features disabled
  • User input is validated (if applicable)
  • No command injection vulnerabilities introduced
  • Changes reviewed for OWASP Top 10 vulnerabilities

πŸ“Έ Screenshots/Logs

Before:

# Show state before changes (if applicable)

After:

# Show state after changes

πŸ”„ Breaking Changes

Does this PR introduce breaking changes?

  • No
  • Yes (explain below)

πŸ“š Documentation Updates

Documentation changes made:

  • README.md updated
  • CLAUDE.md updated (for AI-relevant changes)
  • CHANGELOG.md updated
  • Component-specific README updated
  • Inline code comments added
  • No documentation changes needed

πŸ’¬ Additional Notes

πŸ“ Reviewer Notes

Specific areas to review:


By submitting this PR, I confirm:

  • This code is my own work or properly attributed
  • I agree to license contributions under the MIT License
  • I have followed the security disclosure policy for any security-related changes

Guardian mode cleanup:
- Removed VLAN config section from guardian.yaml template
- Removed OpenFlow SDN config (not needed for simple mode)
- Updated installation banner to show Guardian-specific features
- Updated log messages to remove VLAN references

Guardian is now focused on portable travel security with:
- Simple WiFi hotspot (all devices on br0)
- MAC tracking for connected devices UI
- Full security stack (IDS, WAF, XDP)
- WAN failover support

VLAN segmentation remains documented as a Fortress mode feature
requiring VAP-capable WiFi adapters.
Major README rewrite for Guardian simple mode:
- Removed all VLAN segmentation documentation
- Removed OpenFlow SDN architecture diagrams
- Removed RADIUS VLAN assignment docs
- Added clear "Guardian vs Fortress" comparison table
- Added "Want More Customization?" section pointing to Fortress
- Added "Upgrading to Fortress" section with hardware recommendations
- Documented PCIe network cards (Intel AX210, i225, Mellanox)
- Simplified network architecture diagram (single br0 network)
- Streamlined installation and configuration sections

Guardian is now clearly positioned as:
- Simple portable travel security
- Any USB WiFi adapter works
- All devices on same network

Fortress is positioned for:
- VLAN segmentation
- PCIe network cards
- OpenFlow SDN
- Enterprise networking
@homepods homepods merged commit 37cf2cc into main Dec 6, 2025
32 checks passed
@homepods homepods deleted the claude/enhance-guardian-threat-detection-01W33gtXRC7vHbyCbyKqjpTa branch December 6, 2025 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants