Docs
安装说明

安装说明

克隆 GitLab main,并配置源码 Docker Compose 部署。

English

简体中文

获取源码

准备 Git、Docker、Docker Compose V2,克隆 main 分支:

git clone --branch main --single-branch https://gitlab.vetoedkkb.com/short-links/web.git wr.do
cd wr.do
cp .env.example .env

更新已有部署时请保留原 .env。源码 Compose 构建无需在宿主机安装 Node.js 或 pnpm,Dockerfile 会安装构建依赖。

配置 .env

为 POSTGRES_PASSWORD 与 AUTH_SECRET 填写独立随机值,可运行两次 openssl rand -hex 32 生成。密钥不要提交到 Git,也不要使用示例密码。

变量默认值或配置用途
APP_PORT3100宿主机和容器使用的应用端口。
POSTGRES_PASSWORD必填随机值Compose PostgreSQL 数据库密码。
AUTH_SECRET必填独立随机值认证密钥。
NEXT_PUBLIC_APP_URLhttp://localhost:3100构建时写入浏览器代码的应用地址。
AUTH_URLhttp://localhost:3100认证回调地址,与应用地址一致。
NEXT_PUBLIC_APP_NAMEWR.DO网站名称。
NEXT_PUBLIC_SUPPORT_EMAIL自己的联系邮箱联系站长地址。

默认 Compose 将 DATABASE_URL 设置为内部 PostgreSQL 服务地址。NEXT_PUBLIC_ 开头的变量会公开到浏览器,不能放入私密密钥。

可选服务

只配置需要使用的服务。账号密码登录不依赖外部 OAuth。

服务变量或设置说明
Google OAuthGOOGLE_CLIENT_ID、GOOGLE_CLIENT_SECRET认证
GitHub OAuthGITHUB_ID、GITHUB_SECRET认证
LinuxDO OAuthLinuxDo_CLIENT_ID、LinuxDo_CLIENT_SECRETLinuxDO Connect
发件服务RESEND_API_KEY 或 BREVO_API_KEY、EMAIL_FROM、EMAIL_FROM_NAME邮件
收件服务Cloudflare Worker、NEXT_PUBLIC_EMAIL_R2_DOMAIN邮件 Worker
截图服务SCREENSHOTONE_BASE_URL快速开始
DNS 与存储管理后台中的提供商配置Cloudflare、存储
统计服务NEXT_PUBLIC_GOOGLE_ID 或 NEXT_PUBLIC_UMAMI_SCRIPT、NEXT_PUBLIC_UMAMI_WEBSITE_ID按提供商说明设置

未配置的登录方式可在后台关闭。修改公开配置后需要重新构建应用镜像。

运行项目

docker compose build
docker compose up -d
docker compose ps -a

访问 http://localhost:3100。migrate 显示 Exited (0) 表示数据库迁移成功。访问、日志、备份和更新见 部署指南。

以下社区教程可能针对旧版本或其他部署方式: