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_PORT | 3100 | 宿主机和容器使用的应用端口。 |
| POSTGRES_PASSWORD | 必填随机值 | Compose PostgreSQL 数据库密码。 |
| AUTH_SECRET | 必填独立随机值 | 认证密钥。 |
| NEXT_PUBLIC_APP_URL | http://localhost:3100 | 构建时写入浏览器代码的应用地址。 |
| AUTH_URL | http://localhost:3100 | 认证回调地址,与应用地址一致。 |
| NEXT_PUBLIC_APP_NAME | WR.DO | 网站名称。 |
| NEXT_PUBLIC_SUPPORT_EMAIL | 自己的联系邮箱 | 联系站长地址。 |
默认 Compose 将 DATABASE_URL 设置为内部 PostgreSQL 服务地址。NEXT_PUBLIC_ 开头的变量会公开到浏览器,不能放入私密密钥。
可选服务
只配置需要使用的服务。账号密码登录不依赖外部 OAuth。
| 服务 | 变量或设置 | 说明 |
|---|---|---|
| Google OAuth | GOOGLE_CLIENT_ID、GOOGLE_CLIENT_SECRET | 认证 |
| GitHub OAuth | GITHUB_ID、GITHUB_SECRET | 认证 |
| LinuxDO OAuth | LinuxDo_CLIENT_ID、LinuxDo_CLIENT_SECRET | LinuxDO 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) 表示数据库迁移成功。访问、日志、备份和更新见 部署指南。
以下社区教程可能针对旧版本或其他部署方式: