Skip to content

Commit 9a1d5da

Browse files
committed
fix:增加一键全依赖裸机安装说明
1 parent 105290c commit 9a1d5da

2 files changed

Lines changed: 90 additions & 0 deletions

File tree

docs/en/guide/oneclickvirt/oneclickvirt_install.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Hardware requirements include at least 1G of free memory and 2G of free disk spa
2929
| Docker Deployment (Pre-built Image) | Quick deployment, larger resource usage | One-click installation, data persistence | Requires Docker environment, large image download |
3030
| Docker Compose Deployment | Suitable for source code updates and maintenance | Highly customizable | Requires Docker environment, lengthy compilation time |
3131
| Dockerfile Self-Compilation | Suitable for source code updates and maintenance | Highly customizable | Requires Docker environment, lengthy compilation time |
32+
| One-Click Full-Stack Script | Bare-metal quick deployment | Fully automated: DB, reverse proxy, TLS, frontend & backend | Higher hardware requirements (10G disk/2G memory) |
3233

3334
### Installation via Pre-compiled Binary Files
3435

@@ -493,6 +494,46 @@ docker run -d \
493494
oneclickvirt:no-db
494495
```
495496

497+
### One-Click Full-Stack Installation Script
498+
499+
`install_full.sh` installs the database, reverse proxy, TLS configuration, frontend, backend, and system service in one flow. It supports MySQL or MariaDB and Caddy, Nginx, or OpenResty.
500+
501+
The domain input auto-detects protocol prefixes: enter `https://panel.example.com` to auto-enable TLS, `http://panel.example.com` to auto-disable TLS, or a plain domain to be prompted interactively.
502+
503+
#### Download Script
504+
505+
```shell
506+
curl -fsSL https://raw.githubusercontent.com/oneclickvirt/oneclickvirt/main/install_full.sh -o install_full.sh
507+
```
508+
509+
#### Interactive Installation
510+
511+
```bash
512+
bash install_full.sh
513+
```
514+
515+
#### Non-Interactive Deployment
516+
517+
```bash
518+
# HTTPS with auto TLS
519+
bash install_full.sh \
520+
--non-interactive \
521+
--domain https://panel.example.com \
522+
--email admin@example.com \
523+
--db-type mariadb \
524+
--proxy caddy
525+
526+
# HTTP only, no TLS
527+
bash install_full.sh \
528+
--non-interactive \
529+
--domain http://192.168.1.100 \
530+
--proxy caddy
531+
```
532+
533+
:::warning
534+
The installer requires at least 10 GB free disk and 2 GB memory by default. It writes the generated database password to the final installation summary; save it before closing the terminal.
535+
:::
536+
496537
## Database Initialization
497538

498539
If you install via the Docker all-in-one image, you **do not need** to manually install ```mysql```. The included database eliminates the need to create an empty database yourself; the corresponding database is already started and available within the container by default, so you can proceed directly to the subsequent initialization steps. For other installation methods that do not include a pre-installed database (such as those using non-all-in-one images, scripts, or custom compilation), you **must** install `mysql` yourself. After installing and starting `mysql`, create an empty database named `oneclickvirt` with the `utf8mb4` character set. It is recommended that this database be accessible only locally via `127.0.0.1`. Be sure to keep the corresponding username and password secure.

docs/guide/oneclickvirt/oneclickvirt_install.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ outline: deep
2929
| Docker部署(预构建镜像) | 快速部署,占用较大 | 一键安装、数据持久化 | 需要Docker环境,下载镜像较大 |
3030
| DockerCompose部署 | 适合源码更新维护 | 高度自定义 | 需要Docker环境,编译耗时长 |
3131
| Dockerfile自编译 | 适合源码更新维护 | 高度自定义 | 需要Docker环境,编译耗时长 |
32+
| 一键全栈安装脚本 | 裸金属快速部署 | 全自动安装数据库/反向代理/TLS/前后端 | 硬件要求较高(10G磁盘/2G内存) |
3233

3334
### 通过预编译二进制文件安装
3435

@@ -505,6 +506,54 @@ docker run -d \
505506
oneclickvirt:no-db
506507
```
507508

509+
### 通过一键全栈安装脚本
510+
511+
`install_full.sh` 可一键安装数据库、反向代理、TLS 配置、前端、后端及系统服务,支持 MySQL/MariaDB 以及 Caddy/Nginx/OpenResty。
512+
513+
域名输入支持自动识别协议前缀:输入 `https://panel.example.com` 自动启用 TLS,输入 `http://panel.example.com` 自动禁用 TLS,输入纯域名则交互式询问。
514+
515+
#### 下载脚本
516+
517+
国际
518+
519+
```shell
520+
curl -fsSL https://raw.githubusercontent.com/oneclickvirt/oneclickvirt/main/install_full.sh -o install_full.sh
521+
```
522+
523+
国内
524+
525+
```shell
526+
curl -fsSL https://cdn.spiritlhl.net/https://raw.githubusercontent.com/oneclickvirt/oneclickvirt/main/install_full.sh -o install_full.sh
527+
```
528+
529+
#### 交互式安装
530+
531+
```bash
532+
bash install_full.sh
533+
```
534+
535+
#### 非交互式部署
536+
537+
```bash
538+
# HTTPS 自动 TLS
539+
bash install_full.sh \
540+
--non-interactive \
541+
--domain https://panel.example.com \
542+
--email admin@example.com \
543+
--db-type mariadb \
544+
--proxy caddy
545+
546+
# 仅 HTTP,无 TLS
547+
bash install_full.sh \
548+
--non-interactive \
549+
--domain http://192.168.1.100 \
550+
--proxy caddy
551+
```
552+
553+
:::warning
554+
安装程序默认要求至少 10 GB 可用磁盘空间和 2 GB 内存。安装完成后,终端会输出生成的数据库密码,请在关闭终端前妥善保存。
555+
:::
556+
508557
## 数据库初始化
509558

510559
通过docker一体化安装的**无需**手动再安装```mysql```,自带数据库无需自己创建空数据库,默认已在容器中启动了对应的数据库可用了,直接进入后续初始化环节;其他不自带数据库的安装方式(非一体化镜像安装的、脚本安装的、自己编译安装的),**需要**自行安装```mysql```,确保安装启动```mysql```后,创建一个空的数据库```oneclickvirt```,使用类型```utf8mb4```,最好仅本地```127.0.0.1```可访问,对应用户名和密码保存好。

0 commit comments

Comments
 (0)