Welcome to the comprehensive documentation for the OPNSense MCP Server.
Start here if you're new to OPNSense MCP:
- Installation Guide - Complete setup instructions
- Quick Start - Get running in 5 minutes
- Configuration - Detailed configuration options
Learn how to use specific features:
- VLAN Management - Network segmentation
- Firewall Rules - Security configuration
- DNS Blocking - Content filtering
- DHCP Management - IP address management
- ARP Tables - Device discovery
- HAProxy - Load balancing
- Backup & Restore - Configuration management
Deploy infrastructure declaratively:
- Overview - IaC concepts and benefits
- Resource Model - Resource types and properties
- Deployment - Planning and execution
- Patterns - Reusable configurations
Complete technical reference:
- Tools - All available MCP tools
- Resources - Resource type reference
- Schemas - Data validation schemas
Solve common problems:
- Common Issues - Frequent problems and solutions
- Connection Problems - Network and API issues
- Authentication - Credential problems
- FAQ - Frequently asked questions
- Create a guest network
- Block websites
- Find devices on network
- Set up port forwarding
- Configure load balancing
Use these keywords to find what you need:
- vlan - Network segmentation
- firewall - Security rules
- dns - Domain blocking
- dhcp - IP management
- arp - Device discovery
- haproxy - Load balancing
- backup - Configuration management
- iac - Infrastructure as Code
Find working examples in the examples/ directory:
- Basic Examples - Simple use cases
- Advanced Examples - Complex scenarios
- IaC Patterns - Reusable templates
If you find errors or missing information:
- Check the latest documentation
- Open an issue
For technical questions:
- Check Troubleshooting
- Search existing issues
- Ask in Discussions
We welcome contributions to the documentation:
- Fix typos and errors
- Add examples
- Improve explanations
- Translate documentation
See our Contributing Guide for details.
Version: 0.7.0 | Last Updated: 2024