Skip to content

Commit 571a933

Browse files
committed
fix:添加更详细的说明
1 parent 459f8ff commit 571a933

File tree

4 files changed

+57
-17
lines changed

4 files changed

+57
-17
lines changed

docs/en/guide/oneclickvirt/oneclickvirt_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Distinguishes between panel side and controlled side. The controlled side needs
88

99
## Controlled Side
1010

11-
Corresponds to other main installations in this documentation for environment installation, which will not be elaborated here.
11+
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.
1212

1313
## Panel Side
1414

docs/en/guide/oneclickvirt/oneclickvirt_precheck.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ outline: deep
44

55
# Preface
66

7+
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.
8+
79
Welcome to give the project a ```Star``` for free support --> [https://github.com/oneclickvirt/oneclickvirt](https://github.com/oneclickvirt/oneclickvirt)
810

911
## Environment Requirements
@@ -12,20 +14,38 @@ Supported architectures: amd64 or arm64
1214

1315
Supported systems: Linux, Windows
1416

15-
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.
17+
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.
1618

17-
This control panel has no environmental dependency requirements, only a backend started as a daemon process and a corresponding frontend static file folder.
19+
This control panel has no environment dependency requirements, only a backend started by a daemon process and a corresponding frontend static file folder.
1820

19-
Frontend static files can be deployed through nginx or caddy.
21+
Frontend static files can be deployed through ```nginx``` or ```caddy``` or ```OpenResty```, non-source code deployment requires API path reverse proxy to backend port.
2022

2123
## Platform Features
2224

23-
- All code is open source, commercial use is not allowed
25+
- Provider Integration: Supports ProxmoxVE, Incus, Docker, LXD four major mainstream virtualization platforms
26+
27+
- Flexible Instance Types: Supports creating virtual machines (VM) and containers (Container), providing unified virtualized resource management experience through abstracted design
28+
29+
- 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
30+
31+
- Automatic NAT port mapping: Supports IPv4/IPv6 automatic port mapping, multiple network types:
32+
33+
```
34+
NAT IPv4
35+
NAT IPv4 + Independent IPv6
36+
Independent IPv4
37+
Independent IPv4 + IPv6
38+
Pure IPv6
39+
```
40+
41+
- Flexible port mapping methods: Automatically selects optimal mapping solutions based on different Providers (native, device proxy, iptables, etc.)
42+
43+
- Integrates vnStat for precise network traffic statistics, forces traffic data synchronization during sensitive operations to ensure data accuracy,
2444

25-
- Supports connecting to Providers such as ProxmoxVE, Incus, Docker, LXD for virtualization, supporting the creation of virtual machines or containers
45+
- Unified reset of user traffic usage statistics at the beginning of each month, supports user-level, instance-level, Provider-level traffic statistics and restrictions
2646

27-
- Supports automatic NAT public port mapping, flexible configuration of the Provider's network type, and creating virtual machines or containers with independent IPv6 addresses
47+
- Supports invitation code system, implementing non-public registration mechanism, setting different resource quota restrictions based on user levels
2848

29-
- Supports traffic monitoring, forces synchronization of traffic for sensitive operations, and resets traffic usage uniformly at the beginning of the month
49+
- Supports multiple resource restrictions, instance quantity/CPU/memory/disk/bandwidth quota management, traffic usage restrictions
3050

31-
- Supports invitation code registration instead of public registration, and user level management for setting resource limits
51+
- All code is open source, cannot be used commercially

docs/guide/oneclickvirt/oneclickvirt_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ outline: deep
88

99
## 受控端
1010

11-
对应本说明别的主体安装进行环境安装,这里不过多赘述
11+
对应本说明别的主体安装进行环境安装,这里不过多赘述,四大主流的虚拟化技术的主体安装本教程都有对应的安装命令进行安装,自行查阅。
1212

1313
## 面板端
1414

docs/guide/oneclickvirt/oneclickvirt_precheck.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ outline: deep
44

55
# 前言
66

7+
这是一个用于对接主流虚拟化技术的控制面板,补足虚拟化技术本身不支持的用户管理、流量监控、NAT端口映射以及自定义系统镜像等内容。
8+
79
欢迎给项目一个```Star```进行免费的支持-->[https://github.com/oneclickvirt/oneclickvirt](https://github.com/oneclickvirt/oneclickvirt)
810

911
## 环境需求
@@ -12,20 +14,38 @@ outline: deep
1214

1315
支持的系统:Linux、Windows
1416

15-
只要有公网就行,部署的机器不必有独立的公网IP地址,这只是一个虚拟化的控制面板。
17+
只要有公网就行,部署的机器不必有独立的公网IP地址,这只是一个虚拟化的控制面板,有端口显示前端就行
1618

1719
本控制面板无环境依赖需求,仅一个守护进程启动的后端和一个对应的前端静态文件的文件夹。
1820

19-
前端静态文件通过nginx或者caddy部署即可
21+
前端静态文件通过```nginx``````caddy``````OpenResty```之一部署即可,非源码部署需要进行API路径反代到后端端口
2022

2123
## 平台特点
2224

23-
- 所有代码开源,不可进行商用
25+
- 对接Provider: 支持 ProxmoxVE、Incus、Docker、LXD 四大主流虚拟化平台
26+
27+
- 灵活实例类型: 支持创建虚拟机(VM)和容器(Container),通过抽象化设计提供统一的虚拟化资源管理体验
28+
29+
- 自带镜像种子数据,无需自行查找对应平台的镜像,所有平台均自带自编译的镜像加载,支持统一管理
30+
31+
- 自动NAT端口映射: 支持IPv4/IPv6的自动端口映射,多种网络类型:
32+
33+
```
34+
NAT IPv4
35+
NAT IPv4 + 独立IPv6
36+
独立IPv4
37+
独立IPv4 + IPv6
38+
纯IPv6
39+
```
40+
41+
- 灵活端口映射方式: 根据不同Provider自动选择最佳映射方案(原生、设备代理、iptables等)
42+
43+
- 集成vnStat进行精确的网络流量统计, 敏感操作时强制同步流量数据,确保数据准确性,
2444

25-
- 对接支持Provider如 ProxmoxVE、Incus、Docker、LXD 进行虚拟化,支持开设虚拟机或容器
45+
- 每月初统一重置用户流量使用统计,支持用户级、实例级、Provider级的流量统计和限制
2646

27-
- 支持自动的NAT公网端口映射,支持灵活设置Provider的网络类型,开设带独立IPV6地址的虚拟机或容器
47+
- 支持邀请码系统,实现非公开注册机制,根据用户等级设置不同的资源配额限制
2848

29-
- 支持流量监控,敏感操作强行同步流量,月初统一重置流量使用
49+
- 支持多种资源闲着,实例数量/CPU/内存/磁盘/带宽配额管理,流量使用限制
3050

31-
- 支持邀请码注册非公开注册,支持用户等级管理设置资源限制
51+
- 所有代码开源,不可进行商用

0 commit comments

Comments
 (0)