mirror of https://github.com/gl-inet/glkvm-cloud.git synced 2026-09-11 21:38:55 +00:00

Files

T

GL.iNet-Yongping.Xie 8703f91ebf feat: support configurable device access domain in proxy mode

Allow device remote access to use a different root domain from the Web UI when
running behind a reverse proxy.

Signed-off-by: GL.iNet-Yongping.Xie <yongping.xie@gl-inet.com>

2026-01-06 23:13:39 -08:00

4.2 KiB

Executable File

Raw Permalink Blame History

快速开始（Quick Start）

本指南展示如何使用提供的 Docker Compose 环境模板部署 glkvm-cloud。

1. 克隆仓库并准备环境模板

git clone https://github.com/gl-inet/glkvm-cloud.git
cd glkvm-cloud/docker-compose/

x86_64（amd64）平台：
```
cp .env.example .env
```
arm64（AArch64）平台：
```
cp .env.arm64.example .env
```

2. 配置环境变量

编辑 .env 文件，并根据需求更新关键参数：

RTTYS_TOKEN：设备连接令牌（留空则使用默认值）
RTTYS_PASS：Web 管理密码（留空则使用默认值 StrongP@ssw0rd）
TURN_USER / TURN_PASS：coturn 鉴权凭据（留空则使用默认值）
GLKVM_ACCESS_IP：GLKVM Cloud 访问地址（留空则启动时自动检测）

LDAP 认证（可选）

LDAP_ENABLED：设为 true 启用 LDAP（默认 false）
LDAP_SERVER：LDAP 服务器域名或 IP
LDAP_PORT：端口（默认 389，TLS 使用 636）
LDAP_USE_TLS：设为 true 启用 TLS 加密（默认 false）
LDAP_BIND_DN：服务账号 DN
LDAP_BIND_PASSWORD：服务账号密码
LDAP_BASE_DN：用户查询的 Base DN
LDAP_USER_FILTER：用户查询过滤器（默认 (uid=%s)）
LDAP_ALLOWED_GROUPS：允许访问的群组列表（可选）
LDAP_ALLOWED_USERS：允许访问的用户列表（可选）

⚠️ 注意：所有配置均需在 .env 中完成，不需要修改 docker-compose.yml、模板或脚本。

OIDC 认证（可选）

OIDC_ENABLED：设为 true 启用 OIDC（默认 false）
OIDC_ISSUER：OIDC Issuer 地址示例：https://accounts.google.com、https://your-tenant.auth0.com/
OIDC_CLIENT_ID：OIDC 客户端 ID
OIDC_CLIENT_SECRET：OIDC 客户端密钥
OIDC_AUTH_URL：授权端点 URL
OIDC_TOKEN_URL：令牌端点 URL
OIDC_REDIRECT_URL：OIDC 回调地址域名可自定义，但路径必须为 /auth/oidc/callback 示例：https://your-domain.example.com/auth/oidc/callback
OIDC_SCOPES：请求的 OIDC Scope（默认 "openid profile email"）
OIDC_ALLOWED_USERS：允许的邮箱或域（可选）示例：user@example.com,@example.com
OIDC_ALLOWED_SUBS：允许的 OIDC sub ID 列表（可选）
OIDC_ALLOWED_USERNAMES：允许的用户名列表（可选）
OIDC_ALLOWED_GROUPS：允许的用户组列表（可选）

反向代理模式（可选）

REVERSE_PROXY_ENABLED=false

启用后（REVERSE_PROXY_ENABLED=true）：

GLKVM Cloud 运行在反向代理（如 Nginx）之后
TLS 由反向代理终止，GLKVM Cloud 内部使用 HTTP
Web UI 与设备远程访问可共用同一个 HTTPS 端口（通常为 443）

必需的反向代理请求头

反向代理必须转发以下请求头，否则可能生成包含内部端口（如 :10443）的访问地址：

proxy_set_header Host                $host;
proxy_set_header X-Forwarded-Host    $host;
proxy_set_header X-Forwarded-Proto   $scheme;
proxy_set_header X-Forwarded-Port    $server_port;
proxy_set_header X-Real-IP           $remote_addr;
proxy_set_header X-Forwarded-For     $proxy_add_x_forwarded_for;

设备远程访问域名（可选）

DEVICE_ENDPOINT_HOST=

仅在 REVERSE_PROXY_ENABLED=true 时生效
用于指定设备远程访问使用的域名
生成的设备访问地址格式为：

https://<deviceId>.<DEVICE_ENDPOINT_HOST>/

说明：

不需要包含 http(s):// 或路径
可与 Web UI 域名不同
留空时，将从 X-Forwarded-* 请求头自动推导

示例：

https://www.example.com             → Web UI
https://<deviceId>.kvm.example.com  → 设备远程访问
DEVICE_ENDPOINT_HOST=kvm.example.com