From 571a933ccaedfb89b9acd407fde221fae3a5a4b0 Mon Sep 17 00:00:00 2001 From: spiritlhl <103393591+spiritLHLS@users.noreply.github.com> Date: Sat, 27 Sep 2025 08:59:21 +0000 Subject: [PATCH] =?UTF-8?q?fix=EF=BC=9A=E6=B7=BB=E5=8A=A0=E6=9B=B4?= =?UTF-8?q?=E8=AF=A6=E7=BB=86=E7=9A=84=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../oneclickvirt/oneclickvirt_install.md | 2 +- .../oneclickvirt/oneclickvirt_precheck.md | 36 ++++++++++++++----- .../oneclickvirt/oneclickvirt_install.md | 2 +- .../oneclickvirt/oneclickvirt_precheck.md | 34 ++++++++++++++---- 4 files changed, 57 insertions(+), 17 deletions(-) diff --git a/docs/en/guide/oneclickvirt/oneclickvirt_install.md b/docs/en/guide/oneclickvirt/oneclickvirt_install.md index 331aa7f2d7..97140ab224 100644 --- a/docs/en/guide/oneclickvirt/oneclickvirt_install.md +++ b/docs/en/guide/oneclickvirt/oneclickvirt_install.md @@ -8,7 +8,7 @@ Distinguishes between panel side and controlled side. The controlled side needs ## Controlled Side -Corresponds to other main installations in this documentation for environment installation, which will not be elaborated here. +For the main installation corresponding to this guide, the environment setup is covered elsewhere and will not be repeated here. Installation commands for the main setup of the four major virtualization technologies are provided in this tutorial; please refer to them as needed. ## Panel Side diff --git a/docs/en/guide/oneclickvirt/oneclickvirt_precheck.md b/docs/en/guide/oneclickvirt/oneclickvirt_precheck.md index 9d4d2b96f1..3b4926a089 100644 --- a/docs/en/guide/oneclickvirt/oneclickvirt_precheck.md +++ b/docs/en/guide/oneclickvirt/oneclickvirt_precheck.md @@ -4,6 +4,8 @@ outline: deep # Preface +This is a control panel for interfacing with mainstream virtualization technologies, supplementing content not supported by virtualization technologies themselves such as user management, traffic monitoring, NAT port mapping, and custom system images. + Welcome to give the project a ```Star``` for free support --> [https://github.com/oneclickvirt/oneclickvirt](https://github.com/oneclickvirt/oneclickvirt) ## Environment Requirements @@ -12,20 +14,38 @@ Supported architectures: amd64 or arm64 Supported systems: Linux, Windows -As long as there is public network access, the deployed machine does not need to have a dedicated public IP address. This is only a virtualization control panel. +Just need public network access, the deployed machine doesn't need to have an independent public IP address, this is just a virtualization control panel, as long as there are ports displaying the frontend. -This control panel has no environmental dependency requirements, only a backend started as a daemon process and a corresponding frontend static file folder. +This control panel has no environment dependency requirements, only a backend started by a daemon process and a corresponding frontend static file folder. -Frontend static files can be deployed through nginx or caddy. +Frontend static files can be deployed through ```nginx``` or ```caddy``` or ```OpenResty```, non-source code deployment requires API path reverse proxy to backend port. ## Platform Features -- All code is open source, commercial use is not allowed +- Provider Integration: Supports ProxmoxVE, Incus, Docker, LXD four major mainstream virtualization platforms -- Supports connecting to Providers such as ProxmoxVE, Incus, Docker, LXD for virtualization, supporting the creation of virtual machines or containers +- Flexible Instance Types: Supports creating virtual machines (VM) and containers (Container), providing unified virtualized resource management experience through abstracted design -- Supports automatic NAT public port mapping, flexible configuration of the Provider's network type, and creating virtual machines or containers with independent IPv6 addresses +- Built-in image seed data, no need to search for corresponding platform images yourself, all platforms come with self-compiled image loading, supporting unified management -- Supports traffic monitoring, forces synchronization of traffic for sensitive operations, and resets traffic usage uniformly at the beginning of the month +- Automatic NAT port mapping: Supports IPv4/IPv6 automatic port mapping, multiple network types: -- Supports invitation code registration instead of public registration, and user level management for setting resource limits +``` +NAT IPv4 +NAT IPv4 + Independent IPv6 +Independent IPv4 +Independent IPv4 + IPv6 +Pure IPv6 +``` + +- Flexible port mapping methods: Automatically selects optimal mapping solutions based on different Providers (native, device proxy, iptables, etc.) + +- Integrates vnStat for precise network traffic statistics, forces traffic data synchronization during sensitive operations to ensure data accuracy, + +- Unified reset of user traffic usage statistics at the beginning of each month, supports user-level, instance-level, Provider-level traffic statistics and restrictions + +- Supports invitation code system, implementing non-public registration mechanism, setting different resource quota restrictions based on user levels + +- Supports multiple resource restrictions, instance quantity/CPU/memory/disk/bandwidth quota management, traffic usage restrictions + +- All code is open source, cannot be used commercially \ No newline at end of file diff --git a/docs/guide/oneclickvirt/oneclickvirt_install.md b/docs/guide/oneclickvirt/oneclickvirt_install.md index 34b4c698dd..6e344ec61a 100644 --- a/docs/guide/oneclickvirt/oneclickvirt_install.md +++ b/docs/guide/oneclickvirt/oneclickvirt_install.md @@ -8,7 +8,7 @@ outline: deep ## 受控端 -对应本说明别的主体安装进行环境安装,这里不过多赘述 +对应本说明别的主体安装进行环境安装,这里不过多赘述,四大主流的虚拟化技术的主体安装本教程都有对应的安装命令进行安装,自行查阅。 ## 面板端 diff --git a/docs/guide/oneclickvirt/oneclickvirt_precheck.md b/docs/guide/oneclickvirt/oneclickvirt_precheck.md index daf96f8b13..6d7fd32d92 100644 --- a/docs/guide/oneclickvirt/oneclickvirt_precheck.md +++ b/docs/guide/oneclickvirt/oneclickvirt_precheck.md @@ -4,6 +4,8 @@ outline: deep # 前言 +这是一个用于对接主流虚拟化技术的控制面板,补足虚拟化技术本身不支持的用户管理、流量监控、NAT端口映射以及自定义系统镜像等内容。 + 欢迎给项目一个```Star```进行免费的支持-->[https://github.com/oneclickvirt/oneclickvirt](https://github.com/oneclickvirt/oneclickvirt) ## 环境需求 @@ -12,20 +14,38 @@ outline: deep 支持的系统:Linux、Windows -只要有公网就行,部署的机器不必有独立的公网IP地址,这只是一个虚拟化的控制面板。 +只要有公网就行,部署的机器不必有独立的公网IP地址,这只是一个虚拟化的控制面板,有端口显示前端就行。 本控制面板无环境依赖需求,仅一个守护进程启动的后端和一个对应的前端静态文件的文件夹。 -前端静态文件通过nginx或者caddy部署即可。 +前端静态文件通过```nginx```或```caddy```或```OpenResty```之一部署即可,非源码部署需要进行API路径反代到后端端口。 ## 平台特点 -- 所有代码开源,不可进行商用 +- 对接Provider: 支持 ProxmoxVE、Incus、Docker、LXD 四大主流虚拟化平台 -- 对接支持Provider如 ProxmoxVE、Incus、Docker、LXD 进行虚拟化,支持开设虚拟机或容器 +- 灵活实例类型: 支持创建虚拟机(VM)和容器(Container),通过抽象化设计提供统一的虚拟化资源管理体验 -- 支持自动的NAT公网端口映射,支持灵活设置Provider的网络类型,开设带独立IPV6地址的虚拟机或容器 +- 自带镜像种子数据,无需自行查找对应平台的镜像,所有平台均自带自编译的镜像加载,支持统一管理 -- 支持流量监控,敏感操作强行同步流量,月初统一重置流量使用 +- 自动NAT端口映射: 支持IPv4/IPv6的自动端口映射,多种网络类型: -- 支持邀请码注册非公开注册,支持用户等级管理设置资源限制 \ No newline at end of file +``` +NAT IPv4 +NAT IPv4 + 独立IPv6 +独立IPv4 +独立IPv4 + IPv6 +纯IPv6 +``` + +- 灵活端口映射方式: 根据不同Provider自动选择最佳映射方案(原生、设备代理、iptables等) + +- 集成vnStat进行精确的网络流量统计, 敏感操作时强制同步流量数据,确保数据准确性, + +- 每月初统一重置用户流量使用统计,支持用户级、实例级、Provider级的流量统计和限制 + +- 支持邀请码系统,实现非公开注册机制,根据用户等级设置不同的资源配额限制 + +- 支持多种资源闲着,实例数量/CPU/内存/磁盘/带宽配额管理,流量使用限制 + +- 所有代码开源,不可进行商用 \ No newline at end of file