Operations Guide¶

This section covers the operational aspects of running and maintaining the VPN Exit Controller system.

Quick Links¶

• Deployment - Initial system deployment and setup
• Documentation Build System - Automated documentation builds
• Monitoring - System monitoring and alerting
• Maintenance - Routine maintenance procedures
• Troubleshooting - Common issues and solutions
• Scaling - Scaling the system for growth

Overview¶

Operating the VPN Exit Controller requires understanding several key areas:

🚀 Deployment¶

Learn how to deploy the system from scratch, including infrastructure setup, service configuration, and initial testing.

📚 Documentation Build System¶

Understand how documentation is automatically built and deployed when changes are pushed to the repository. This ensures documentation stays in sync with the codebase.

📊 Monitoring¶

Set up comprehensive monitoring to track system health, performance metrics, and potential issues before they impact users.

🔧 Maintenance¶

Follow routine maintenance procedures to keep the system running smoothly, including updates, backups, and security patches.

🔍 Troubleshooting¶

Quickly diagnose and resolve common issues using our troubleshooting guide and diagnostic tools.

📈 Scaling¶

Plan for growth with our scaling guide, covering both vertical and horizontal scaling strategies.

Key Operational Tasks¶

Daily Tasks¶

• Monitor system health via dashboard
• Check webhook and build logs
• Review error logs for issues
• Verify all VPN nodes are operational

Weekly Tasks¶

• Review performance metrics
• Check disk usage and clean if needed
• Verify backup procedures
• Update documentation as needed

Monthly Tasks¶

• Security updates and patches
• Certificate renewal verification
• Capacity planning review
• Documentation review and updates

Important Locations¶

Configuration Files¶

• Main config: /opt/vpn-exit-controller/
• Service files: /etc/systemd/system/
• Docker configs: Various docker-compose.yml files

Log Files¶

• API logs: journalctl -u vpn-controller
• Webhook logs: /opt/vpn-exit-controller/logs/webhook.log
• Container logs: docker logs [container-name]

Documentation¶

• Source: /opt/vpn-exit-controller/mkdocs-site/docs/
• Live site: https://vpn-docs.rbnk.uk

Getting Help¶

If you encounter issues not covered in these guides:

1. Check the troubleshooting guide
2. Review system logs for error messages
3. Consult the API documentation
4. Check the main documentation index