Skip to content

Commit 4472860

Browse files
committed
fix
1 parent 58b8c3c commit 4472860

8 files changed

Lines changed: 29 additions & 1 deletion

File tree

75.2 KB
Loading

docs/en/guide/oneclickvirt/oneclickvirt_custom.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ For local nodes, only this section differs: choose `No Port Mapping`. You can th
6363

6464
When manually adding port mapping, choose `Controller Forwarding (Intranet Penetration)`. Non-required fields can be left empty; the system will automatically select available controller ports for mapping.
6565

66+
Controller forwarding uses a TCP tunnel and supports one TCP port per mapping. Create separate mappings when multiple ports must be exposed.
67+
6668
### Controller Deployment Requirements
6769

6870
Because intranet penetration requires the controller to have control over the host machine's network and firewall, the controller must meet the following conditions:
@@ -178,4 +180,4 @@ After installation, running `nvidia-smi` inside the container should also return
178180

179181
![](./images/gpu3.jpg)
180182

181-
At this point, you can stop this container and use it as a template. Use the redemption-code batch container creation "copy mode", set this container as the source container, and clone new containers from it.
183+
At this point, you can stop this container and use it as a template. Use the redemption-code batch container creation "copy mode", set this container as the source container, and clone new containers from it.

docs/en/guide/oneclickvirt/oneclickvirt_install.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,8 @@ docker run -d \
498498
oneclickvirt:no-db
499499
```
500500

501+
The `no-db` image stores its runtime configuration at `/app/storage/config.yaml` in the `oneclickvirt-storage` volume. Reuse the same storage volume when updating the image or recreating the container; database settings entered on the initialization page and other system-level settings then survive replacement, so database initialization is not repeated. Non-empty `DB_*` variables take precedence over the file, while deployments that explicitly mount `/app/config.yaml` continue to use that file first.
502+
501503
### One-Click Full-Stack Installation Script
502504

503505
`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.

docs/en/guide/oneclickvirt/oneclickvirt_usage.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,16 @@ If you need images for any system, any virtualization environment, any architect
314314

315315
Custom image addresses are temporarily not supported. The current frontend entry function is not available. Do not manually enter images.
316316

317+
## Port Management
318+
319+
Administrators can inspect and maintain port mapping records under **Resources > Port Management**. Node-side mappings are applied by the corresponding virtualization node. Controller forwarding is intended for tunnel access when a node has no public ingress and currently supports one TCP port per record.
320+
321+
![](./images/portmapping-repair.png)
322+
323+
**Sync Port Mappings** previews and removes stale database records, such as mappings whose instances no longer exist. **Rebuild Forwarding** repairs the opposite direction: selected controller database records are reapplied to the node or controller. The preview separates repairable, restart-required, and skipped records. Execution requires a risk confirmation followed by entering `REBUILD` exactly.
324+
325+
Native container runtime bindings require restarting affected running instances, which causes a brief interruption. The task verifies the actual bindings after restart and reports a clear failure when they do not match the database. This operation does not delete controller database port mapping records.
326+
317327
## System Configuration
318328

319329
General options here won't be elaborated on. There are two configurations that need special explanation.
64.6 KB
Loading

docs/guide/oneclickvirt/oneclickvirt_custom.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ outline: deep
8181

8282
对于非必填项,可以直接留空,系统会自动筛选并分配主控服务器可用端口。
8383

84+
控制端转发使用 TCP 隧道,每条映射仅支持一个 TCP 端口。需要暴露多个端口时,请分别创建多条映射。
85+
8486
### 主控部署要求
8587

8688
由于内网穿透功能需要主控具备对宿主机网络与防火墙的控制能力,因此主控必须满足以下条件

docs/guide/oneclickvirt/oneclickvirt_install.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -510,6 +510,8 @@ docker run -d \
510510
oneclickvirt:no-db
511511
```
512512

513+
`no-db` 镜像会将运行时配置保存到 `oneclickvirt-storage` 卷内的 `/app/storage/config.yaml`。更新镜像或重建容器时必须继续挂载同一个存储卷,初始化页面写入的数据库配置和系统级配置会随卷保留,无需重新初始化数据库。非空的 `DB_*` 环境变量优先于配置文件;显式挂载 `/app/config.yaml` 的部署仍优先使用该文件。
514+
513515
### 通过一键全栈安装脚本
514516

515517
`install_full.sh` 可一键安装数据库、反向代理、TLS 配置、前端、后端及系统服务,支持 MySQL/MariaDB 以及 Caddy/Nginx/OpenResty。

docs/guide/oneclickvirt/oneclickvirt_usage.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,16 @@ API是否可用不影响具体使用,自动配置API是非必需的
314314

315315
暂时不支持自定义镜像地址,目前前端录入的功能是不可用的,不要手动录入镜像。
316316

317+
## 端口管理
318+
319+
管理员可在“资源 > 端口管理”中查看和维护控制端数据库记录的端口映射。手动添加映射时,节点侧映射由对应虚拟化节点写入转发规则;控制端转发适用于节点没有公网入口的内网穿透场景,目前每条记录只支持一个 TCP 端口。
320+
321+
![](./images/portmapping-repair.png)
322+
323+
“同步端口映射”用于预览并清理实例已不存在等情况下遗留的数据库记录。“重建转发规则”执行相反方向的修复:以控制端数据库为准,将选中的记录重新应用到节点或控制端。重建前会列出可修复、需重启和被跳过的记录;执行时需要先确认风险,再完整输入 `REBUILD` 进行二次确认。
324+
325+
容器运行时的原生端口绑定需要重启对应的运行中实例,期间会有短暂中断。任务会在重启后核验实际绑定,未按数据库记录生效时会明确标记失败。该操作不会删除控制端数据库中的端口映射记录。
326+
317327
## 系统配置
318328

319329
一般的选项这里不多赘述了,有必要特殊说明的就两个配置。

0 commit comments

Comments
 (0)