自托管快速入门指南（5分钟）

快速部署使用的是SQLite3数据库。

cloink 是开源的，可以在您自己的服务器上进行自托管。如果您想了解更多关于架构的信息，请参考 架构部分。

这是尝试自托管 cloink 的最快方式。如果您已经有一个公共域名和虚拟机，大约需要 5 分钟即可开始。

基础设施要求

• 一个 Linux 虚拟机，至少需要 4CPU 和 8GB 内存。
• 虚拟机必须在 TCP 端口 80 和 443 以及 UDP 端口 3478 上可公开访问。
• 一个公共域名，解析到虚拟机的公网 IP 地址（例如 cloink.example.com）。

软件要求

• Docker 及 docker-compose 插件（Docker 安装指南）或 Docker 及 docker-compose 版本 2 或更高
• jq - 使用 sudo apt install jq 或 sudo yum install jq 安装
• curl - 使用 sudo apt install curl 或 sudo yum install curl 安装

安装脚本

下载并运行安装脚本-English：

curl -fsSL https://docs.4w.ink/file/get-cloink-en.sh | bash

下载并运行安装脚本-中文：

curl -fsSL https://docs.4w.ink/file/get-cloink-zh.sh | bash

完成后，您可以通过 docker compose 管理资源。快速启动脚本会生成一个完整的、生产就绪的 cloink 安装。

反向代理选择

脚本会提示您选择反向代理选项：

Which reverse proxy will you use?
 [0] Traefik (recommended - automatic TLS, included in Docker Compose)
 [1] Existing Traefik (labels for external Traefik instance)
 [2] Nginx (generates config template)
 [3] Nginx Proxy Manager (generates config + instructions)
 [4] External Caddy (generates Caddyfile snippet)
 [5] Other/Manual (displays setup documentation)

Enter choice [0-5] (default: 0):

在本快速入门指南中，选择选项 [0]（Traefik） - 只需按 Enter 使用默认值。此选项在 Docker Compose 中包含一个 Traefik 容器，可通过 Let's Encrypt 自动处理 TLS 证书，无需额外配置，并便于在下一步中启用 cloink Proxy。

如果您已经有反向代理（Traefik、Nginx 等）并想使用它，脚本将引导您完成设置。

启用 cloink Proxy 服务

当您选择内置 Traefik 选项（[0]）时，脚本会询问您是否要启用 cloink Proxy 服务：

Do you want to enable the cloink Proxy service?
The proxy allows you to selectively expose internal cloink network resources
to the internet. You control which resources are exposed through the dashboard.
Enable proxy? [y/N]:

脚本随后会自动生成代理访问令牌，创建 proxy.env 配置文件，并与其他服务一起启动代理容器。将通配符 DNS 记录（例如 *.cloink.example.com）指向您服务器的 IP 地址，以便服务子域名正确解析。

Proxy 域名的 CNAME 记录

为了使证书正常工作，请确保您在域名注册商处设置了正确的记录。下面的第一条 A 记录应该在启动快速启动脚本之前已经设置好。

类型	名称	内容	Cloudflare 代理状态
A	cloink	YOUR.SERVER.IP.ADDRESS	DNS only
CNAME	*.cloink	cloink.example.com	DNS only

CrowdSec IP 信誉（可选）

启用代理后，脚本还提供添加 CrowdSec 以自动阻止 IP 信誉。本地 CrowdSec LAPI 容器同步社区威胁情报，代理会检查每个传入连接。您可以通过仪表板在强制或观察模式下为每个服务启用 CrowdSec。

生成的文件

脚本生成以下文件：

文件	描述
docker-compose.yml	包含所有服务的 Docker Compose 配置
config.yaml	组合服务器配置（管理、信号、中继、STUN）
dashboard.env	仪表板容器的环境变量
proxy.env	代理容器的环境变量（仅在启用代理时）

对于选项 2-4，会生成额外的配置文件（例如 nginx-cloink.conf、caddyfile-cloink.txt 或 npm-advanced-config.txt）。

初始设置（入门）

脚本部署 cloink 没有任何用户。完成后，您需要创建第一个用户：

1. 打开浏览器并导航到 https://cloink.example.com

2. 您将被重定向到设置页面（/setup）

3. 创建您的管理员账户：

   • 输入您的电子邮件地址
   • 输入您的姓名
   • 输入密码
   • 点击 创建账户

然后您可以使用您的电子邮件和密码登录。

/setup 页面仅在没有用户存在时可访问。创建第一个用户后，它会重定向到常规登录页面。

对于自动化部署，您可以通过设置 API 创建第一个所有者用户，并可选地接收个人访问令牌以引导资源。

故障排除

• 无法访问 /setup 页面

设置页面仅在没有用户存在时可用。如果您已经创建了用户，请转到主登录页面。

• 忘记管理员密码

您可以使用现有管理员的 PAT（个人访问令牌）通过 API 创建新用户，或重置数据库重新开始。

• 登录页面上未显示 SSO 提供者Pro

检查连接器是否在 设置 → 身份提供者 中正确配置。确保在您的 IdP 中正确配置了重定向 URL。