VyConnect is an open-source web interface for managing multiple VyOS routers via the official VyOS REST API instead of SSH ensuring safe connectivity without compromising on security. It provides a centralized way to configure and monitor multiple VyOS routers, with features for NAT, firewalls, interfaces, logging, performance monitoring, and more. The project aims to simplify multi-router management, providing a more integrated and user-friendly approach than managing routers individually via CLI.
Follow the steps below to set up VyConnect and connect it to your VyOS router through the REST API.
On your VyOS router, enable the REST API with the following commands in the VyOS CLI:
set service https api keys id vyconnect key YOUR_SECRET_KEY
set service https api rest
commit && saveReplace YOUR_SECRET_KEY with your own chosen secret key. This is used to securely communicate between VyConnect and your VyOS router.
Ensure your Ethernet interfaces are properly configured with the correct speed and duplex settings.
Copy default.config.json to config.json and modify the values to suit your setup. Be sure to include the correct router settings and REST API credentials.
Use PHP to serve /web. If you are using Windows, you can open host_web.cmd, which runs the webpanel. Make sure you have got a recent version of PHP installed on your host system!
The default password for VyConnect is vyconnect. Use this to log into the web interface.
- NAT & Firewall Configuration: Easily manage NAT and firewall settings.
- Adding Interfaces: Add network interfaces without needing to use the CLI.
- Setup Wizard: A simple setup wizard for installing specific features.
- Performance & Statistics: View performance metrics and statistics for your routers.
- Logging: Manage and view router logs.
- Multiple User Accounts: Support for multiple administrator accounts.
- Security Alerts: Alerts for potential security issues.
- REST API Back-end: Periodically send HTTP requests to VyOS and store the responses.
- Automatic Recommendations: Based on collected statistics, automatic configuration recommendations may be made.
- Unit Tests for VyOS Features: Automatically test the stability of VyOS features in rolling/stable releases.
- Router Group Management: Manage multiple VyOS routers in groups.
- Global Configuration Application: Apply configuration changes across multiple routers or groups.
- Configuration Comparison: Compare configurations between router groups.
- Performance Comparison: Compare performance metrics between different router groups.
For more details on the VyOS REST API and related configuration, refer to the following resources:
Make sure your VyOS router is configured correctly and the REST API is enabled to ensure smooth operation with VyConnect.
VyConnect is an open-source project focused on simplifying the management of multiple VyOS routers. Feel free to contribute or make improvements as you see fit.