Skip to content

Commit 772c3d8

Browse files
committed
fix:添加部分OneClickVirt虚拟化管理平台的安装使用说明
1 parent 4048c9c commit 772c3d8

File tree

4 files changed

+256
-5
lines changed

4 files changed

+256
-5
lines changed

docs/en/guide/oneclickvirt/oneclickvirt_install.md

Lines changed: 105 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,108 @@
22
outline: deep
33
---
44

5-
Occupancy pending construction
5+
# OneClickVirt
6+
7+
Distinguish between the panel side and the controlled side. The controlled side needs to have the corresponding virtualization environment installed in advance. You can use other parts of this documentation for environment installation.
8+
9+
## Controlled Side
10+
11+
Refer to other parts of this documentation for environment installation, no further details are provided here.
12+
13+
## Panel Side
14+
15+
The host machine needs to have ```nginx``` or ```caddy``` and ```mysql``` installed, with at least 1G free memory and 1G free disk space.
16+
17+
After installation, the default startup addresses are:
18+
19+
Frontend: ```http://localhost:8080```
20+
21+
Backend API: ```http://localhost:8888```
22+
23+
API Documentation: ```http://localhost:8888/swagger/index.html```
24+
25+
### Backend Installation
26+
27+
#### Linux
28+
29+
Download and execute:
30+
31+
International:
32+
33+
```shell
34+
curl -L https://raw.githubusercontent.com/oneclickvirt/oneclickvirt/refs/heads/main/install.sh -o install.sh && chmod +x install.sh
35+
````
36+
37+
Domestic:
38+
39+
```shell
40+
curl -L https://cdn.spiritlhl.net/https://raw.githubusercontent.com/oneclickvirt/oneclickvirt/refs/heads/main/install.sh -o install.sh && chmod +x install.sh
41+
```
42+
43+
Interactive installation:
44+
45+
```
46+
./install.sh
47+
```
48+
49+
Non-interactive installation:
50+
51+
```
52+
noninteractive=true ./install.sh
53+
```
54+
55+
Installation directory: `/opt/oneclickvirt`
56+
57+
Usage:
58+
59+
Start service: `systemctl start oneclickvirt`
60+
61+
Stop service: `systemctl stop oneclickvirt`
62+
63+
Enable autostart: `systemctl enable oneclickvirt`
64+
65+
Check status: `systemctl status oneclickvirt`
66+
67+
View logs: `journalctl -u oneclickvirt -f`
68+
69+
#### Windows
70+
71+
See:
72+
73+
[https://github.com/oneclickvirt/oneclickvirt/releases/latest](https://github.com/oneclickvirt/oneclickvirt/releases/latest)
74+
75+
Download the latest compressed file for the corresponding architecture, extract it, and run it.
76+
77+
In the same directory as the executed binary file, download:
78+
79+
[https://cdn.spiritlhl.net/https://raw.githubusercontent.com/oneclickvirt/oneclickvirt/refs/heads/main/server/config.yaml](https://cdn.spiritlhl.net/https://raw.githubusercontent.com/oneclickvirt/oneclickvirt/refs/heads/main/server/config.yaml)
80+
81+
This file is the configuration file needed later.
82+
83+
### Frontend Installation
84+
85+
#### Linux
86+
87+
The previous installation script will extract the static files to:
88+
89+
```shell
90+
cd /opt/oneclickvirt/web/
91+
```
92+
93+
In this path.
94+
95+
Use `nginx` or `caddy` to build a static website with this path. Whether you need domain binding is up to you.
96+
97+
#### Windows
98+
99+
After downloading the `web-dist.zip` file, extract it and use the corresponding program to build a static website.
100+
101+
## MYSQL
102+
103+
After installing MySQL, create an empty database named ```oneclickvirt```. It is recommended to allow access only from local ```127.0.0.1```. Keep the corresponding username and password safe.
104+
105+
After opening the corresponding frontend page, it will automatically redirect to the initialization page. Fill in the database information and related user information, then click to initialize the system.
106+
107+
Once initialization is complete, it will automatically redirect to the homepage, where you can explore and use the system.
108+
109+
## Configuration File (Optional)

docs/en/guide/oneclickvirt/oneclickvirt_precheck.md

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

55
# Preface
66

7-
This control panel has no environmental dependencies required, just a daemon-starting backend and a corresponding folder of static files for the frontend.
7+
Welcome to give the project a ```Star``` for free support --> [https://github.com/oneclickvirt/oneclickvirt](https://github.com/oneclickvirt/oneclickvirt)
88

9-
Feel free to give the project a ```Star``` for free support!-->[https://github.com/oneclickvirt/oneclickvirt](https://github.com/oneclickvirt/oneclickvirt)
9+
## Environment Requirements
10+
11+
Supported architectures: amd64 or arm64
12+
13+
Supported systems: Linux, Windows
14+
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.
16+
17+
This control panel has no environmental dependency requirements, only a backend started as a daemon process and a corresponding frontend static file folder.
18+
19+
Frontend static files can be deployed through nginx or caddy.
20+
21+
## Platform Features
22+
23+
- All code is open source, commercial use is not allowed
24+
25+
- Supports connecting to Providers such as ProxmoxVE, Incus, Docker, LXD for virtualization, supporting the creation of virtual machines or containers
26+
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
28+
29+
- Supports traffic monitoring, forces synchronization of traffic for sensitive operations, and resets traffic usage uniformly at the beginning of the month
30+
31+
- Supports invitation code registration instead of public registration, and user level management for setting resource limits

docs/guide/oneclickvirt/oneclickvirt_install.md

Lines changed: 104 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,108 @@
22
outline: deep
33
---
44

5+
# OneClickVirt
56

6-
占位待施工
7+
区分面板端和受控端,受控端需要提前安装好对应虚拟化的环境,可使用本说明别的主体安装进行环境安装
8+
9+
## 受控端
10+
11+
对应本说明别的主体安装进行环境安装,这里不过多赘述
12+
13+
## 面板端
14+
15+
宿主机需要安装好```nginx``````caddy``````mysql```,需要至少1G空闲内存和1G空闲硬盘。
16+
17+
安装完成后,默认启动的地址
18+
19+
前端:```http://localhost:8080```
20+
21+
后端 API:```http://localhost:8888```
22+
23+
API 文档:```http://localhost:8888/swagger/index.html```
24+
25+
### 后端安装
26+
27+
#### Linux
28+
29+
下载并执行
30+
31+
国际
32+
33+
```shell
34+
curl -L https://raw.githubusercontent.com/oneclickvirt/oneclickvirt/refs/heads/main/install.sh -o install.sh && chmod +x install.sh
35+
```
36+
37+
国内
38+
39+
```shell
40+
curl -L https://cdn.spiritlhl.net/https://raw.githubusercontent.com/oneclickvirt/oneclickvirt/refs/heads/main/install.sh -o install.sh && chmod +x install.sh
41+
```
42+
43+
有交互地安装
44+
45+
```
46+
./install.sh
47+
```
48+
49+
无交互地安装
50+
51+
```
52+
noninteractive=true ./install.sh
53+
```
54+
55+
安装目录: ```/opt/oneclickvirt```
56+
57+
使用方法:
58+
59+
启动服务: ```systemctl start oneclickvirt```
60+
61+
停止服务: ```systemctl stop oneclickvirt```
62+
63+
开机自启: ```systemctl enable oneclickvirt```
64+
65+
查看状态: ```systemctl status oneclickvirt```
66+
67+
查看日志: ```journalctl -u oneclickvirt -f```
68+
69+
#### Windows
70+
71+
查看
72+
73+
https://github.com/oneclickvirt/oneclickvirt/releases/latest
74+
75+
下载最新的对应架构的压缩文件,解压后挂起执行。
76+
77+
执行的二进制文件的同级目录下,下载
78+
79+
https://cdn.spiritlhl.net/https://raw.githubusercontent.com/oneclickvirt/oneclickvirt/refs/heads/main/server/config.yaml
80+
81+
文件,这是后续需要使用的配置文件。
82+
83+
### 前端安装
84+
85+
#### Linux
86+
87+
前面安装脚本会将静态文件解压到
88+
89+
```shell
90+
cd /opt/oneclickvirt/web/
91+
```
92+
93+
这个路径下
94+
95+
使用```nginx``````caddy```以这个路径建立静态网站即可,是否需要域名绑定自行选择
96+
97+
#### Windows
98+
99+
下载```web-dist.zip```文件后,解压并使用对应的程序建立静态网站即可.
100+
101+
## MYSQL
102+
103+
安装mysql后,创建一个空的数据库```oneclickvirt```,最好仅本地```127.0.0.1```可访问,对应用户名和密码保存好。
104+
105+
打开前端对应的页面后,将自动跳转到初始化界面,填写数据库信息和相关用户信息,点击初始化系统。
106+
107+
完成初始化后会自动跳转到首页,可以自行探索并使用了。
108+
109+
## 配置文件(可选)

docs/guide/oneclickvirt/oneclickvirt_precheck.md

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

55
# 前言
66

7+
欢迎给项目一个```Star```进行免费的支持-->[https://github.com/oneclickvirt/oneclickvirt](https://github.com/oneclickvirt/oneclickvirt)
8+
9+
## 环境需求
10+
11+
支持的架构:amd64或arm64
12+
13+
支持的系统:Linux、Windows
14+
15+
只要有公网就行,部署的机器不必有独立的公网IP地址,这只是一个虚拟化的控制面板。
16+
717
本控制面板无环境依赖需求,仅一个守护进程启动的后端和一个对应的前端静态文件的文件夹。
818

9-
欢迎给项目一个```Star```进行免费的支持-->[https://github.com/oneclickvirt/oneclickvirt](https://github.com/oneclickvirt/oneclickvirt)
19+
前端静态文件通过nginx或者caddy部署即可。
20+
21+
## 平台特点
22+
23+
- 所有代码开源,不可进行商用
24+
25+
- 对接支持Provider如 ProxmoxVE、Incus、Docker、LXD 进行虚拟化,支持开设虚拟机或容器
26+
27+
- 支持自动的NAT公网端口映射,支持灵活设置Provider的网络类型,开设带独立IPV6地址的虚拟机或容器
28+
29+
- 支持流量监控,敏感操作强行同步流量,月初统一重置流量使用
30+
31+
- 支持邀请码注册非公开注册,支持用户等级管理设置资源限制

0 commit comments

Comments
 (0)