dvorah-fr/VyManager

选用指南

AI 根据 README 整理 · 2026/10/14 20:56:14 · 基于较早版本，请核对最新 README

适用场景

适用于需要集中管理多个站点 VyOS 路由器的场景，如数据中心和分支机构。

查看 README 依据

## 🚀 About VyManager VyManager is an open‑source, enterprise‑grade control plane for **VyOS** routers. It provides a modern web interface to manage **multiple instances** across different sites, with role‑based access control, live dashboards, and configuration deployment – all from a single pane of glass. - **Multi‑site** – organise routers into logical sites (e.g., datacenters, branch offices). - **Version‑aware** – supports VyOS 1.4, 1.5, and rolling releases. - **Secure** – API‑key authentication, encrypted SSH credentials, and fine‑grained permissions.

使用方式

通过 Web 界面使用，支持 Docker Compose 部署，也可在 VyOS 设备上直接运行。

查看 README 依据

- **Extensible** – built with Next.js, FastAPI, and PostgreSQL. --- ## ✨ Features - **Centralised Management** – add, remove, and configure VyOS instances from one UI. - **Live Dashboards** – real‑time interface counters, system info, network graphs, and WireGuard peers via GraphQL. - **Role‑Based Access Control** – OWNER, ADMIN, VIEWER per site. - **Multi‑Version Support** – automatically adapts features based on the connected VyOS version. - **Docker‑First Deployment** – runs anywhere with Docker Compose. - **Light, Dark & Custom Themes** – choose what suits you. --- ## 🖼️ Screenshots

Run VyManager on the router it manages. Save the script, read it, then run it as `vyos`. Do not pipe curl into vbash. ```bash curl -fsSL https://raw.githubusercontent.com/Community-VyProjects/VyManager/beta/install-vyos.sh -o install-vyos.sh less install-vyos.sh vbash install-vyos.sh ``` Details (prompts, dest NAT, WAN warning): [On-box VyOS install](https://docs.vyprojects.org/getting-started/install-vyos). <!-- > [!NOTE]

部署要求

需要 Docker 和 Docker Compose v2，且每个 VyOS 路由器需启用 REST API 和 GraphQL 并配置 API 密钥。

查看 README 依据

- If you use the **automated script**, it will install Docker and Docker Compose for you. - If you prefer Docker setup, ensure Docker and Docker Compose (v2) are installed on your host. ### 2. Enable the VyOS REST API and GraphQL On **each VyOS router** you want to manage, SSH in and run: ```bash configure set service https api keys id vymanager key YOUR_SECURE_API_KEY set service https api rest set service https api graphql set service https api graphql authentication type key commit save exit ``` > [!IMPORTANT] > - GraphQL is required for live dashboard data.

> If you are on a system that does **not** support KVM (e.g., Docker Desktop on macOS/Windows), the script will warn you about macvlan limitations. See the [Troubleshooting](#-troubleshooting) section. --> --- ### Docker Setup #### Prerequisites (already covered above) - Docker and Docker Compose (v2) installed. - VyOS routers with the REST API and GraphQL enabled. #### 1. Create the Project Directory ```bash mkdir vymanager && cd vymanager ``` #### 2. Create `docker-compose.yml`

已知限制

监控和控制台页面需要 WebSocket 代理升级，且需先配置 SSH；大型配置可能导致 API 超时。

查看 README 依据

The monitoring and console pages open WebSocket connections to the same origin at /vyos/monitoring/ws/... and /vyos/console/ws/...; the proxy must upgrade those paths and forward them to the backend, or those two pages will not work. **Solution:** - These pages need per-instance SSH set up first (Site Manager → edit instance → SSH); the page says so if the key is missing. Verify the public key is committed on the router and the SSH port is reachable. - Put a reverse proxy with TLS in front of VyManager: https://docs.vyprojects.org/operations/reverse-proxy/

> Docker Desktop on Linux, macOS, and Windows does **not** provide KVM access to containers. If you need macvlan networking, consider running on a native Linux host or using a second macvlan interface as a workaround. > [!NOTE] > The install script will detect this and warn you accordingly. --> ### VyOS API Timeouts with Large Configurations > [!NOTE] > VyOS has known performance issues with large configurations, causing commits and boot times to take longer. See [VyOS T5388](https://vyos.dev/T5388).