CyberMind-FR 01246a693d docs: Add comprehensive wiki and module documentation

Wiki structure:
- Home.md: Main navigation with module categories
- Installation.md: Getting started guide
- Quick-Start.md: First-time setup walkthrough
- Architecture.md: 4-layer architecture overview
- Modules.md: Complete catalog of 80+ modules

Module documentation (docs/wiki/modules/):
- Security.md: 15 security modules (CrowdSec, WAF, Guardians)
- Network.md: 12 network modules (HAProxy, Bandwidth, Traffic)
- Mesh.md: 7 VPN/mesh modules (WireGuard, P2P, MirrorNet)
- DNS.md: 6 DNS modules (DNS Master, Vortex, Meshname)
- Apps.md: 20 application modules (Jellyfin, Nextcloud, Matrix)
- System.md: 14 system modules (Config Vault, Reporter, RTTY)
- AI.md: 8 AI modules (Gateway, LocalAI, Threat Analyst)

Updated:
- SCREENSHOTS.md: Expanded to 111 modules with all categories
- README.md: Added wiki links and module index

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2026-03-26 12:35:31 +01:00

2.7 KiB

Raw Blame History

SecuBox Quick Start Guide

Get SecuBox up and running in 10 minutes.

Connect to your SecuBox router via Ethernet
Open browser: https://192.168.1.1 (or 192.168.255.1)
Login with: root / c3box

Step 2: Change Password

Navigate to System > Administration and change the root password.

Step 3: Network Setup

Configure WAN

Go to Network > Interfaces > WAN:

Protocol: DHCP Client (or PPPoE/Static)
Physical interface: eth1

Configure LAN

Go to Network > Interfaces > LAN:

IPv4 address: 192.168.255.1
Netmask: 255.255.255.0
DHCP: Enabled

Step 4: Enable Security

CrowdSec IDS/IPS

Navigate to SecuBox > Security > CrowdSec Dashboard:

Enable CrowdSec
Install default scenarios
Configure bouncer

WAF (Web Application Firewall)

Navigate to SecuBox > Security > WAF Filters:

Enable mitmproxy WAF
Configure filter rules
Set default action: Block

Step 5: Mesh Network

Enable Mesh Daemon

Navigate to SecuBox > Mesh > Network:

Enable mesh daemon
Set node name
Configure WireGuard peers

Add Peers

Use the QR code scanner or manual configuration:

# Generate peer config
secuboxctl peer add mynode 10.10.10.2

Step 6: Service Exposure

Tor Hidden Services

Navigate to SecuBox > Privacy > Tor Shield:

Enable Tor
Add hidden service
Note your .onion address

DNS/SSL Exposure

Navigate to SecuBox > Privacy > Exposure:

Configure DNS provider (OVH, Gandi, Cloudflare)
Add domain
Request SSL certificate

Step 7: Install Apps

Navigate to SecuBox > Apps:

Browse and install from the catalog:

Jellyfin - Media server
Nextcloud - Cloud storage
Gitea - Git server
LocalAI - Local LLM

Common Tasks

View Metrics

SecuBox > Dashboard > Metrics

Monitor Traffic

SecuBox > Monitoring > Bandwidth Manager

Check Security

SecuBox > Security > Security Threats

Manage VPN

SecuBox > VPN > WireGuard Dashboard

CLI Quick Reference

# System status
secubox status

# Mesh network
secuboxctl status
secuboxctl peers

# WireGuard
wgctl status
wgctl peers

# HAProxy
haproxyctl vhost list
haproxyctl status

# CrowdSec
cscli decisions list
cscli alerts list

Next Steps

Module Catalog - Explore all 80+ modules
Architecture - Understand the system
Development - Extend SecuBox

SecuBox v1.0.0

2.7 KiB Raw Blame History