2. 快速入门

快速入门

首次使用的关键前置:木雷短网址使用应用实际收到的 Host + 短码 精确查找短链接。后台填写 s.example.com 时,请求到达应用时的 Host 也必须是 s.example.com;使用非标准端口时,端口也必须一致。只完成 DNS、只配置 HTTPS,或只传递 X-Forwarded-Host 都不够。反向代理必须保留原始 Host,否则后台和健康检查可能正常,但公开短链接仍返回 404。

本章帮助首次使用者完成从启动服务到验证第一条短链接的完整流程。

开始前

  • 确保服务已经启动,并记录实际访问地址。默认监听端口为 8080;如果修改过 HTTP_ADDR 或反向代理配置,请使用实际地址。
  • 首次访问服务根地址时,系统会自动跳转到 /install/index
  • 准备一个用于公开短链访问的域名。管理后台地址、反向代理上游地址和公开短域名可以不同;正式环境应提前配置 DNS、证书和反向代理,并确保代理向应用传递公开短域名作为 Host。本地验证也可以使用带端口的 IP 地址,但后台域名必须填写相同的 IP:端口
  • 如果选择 MySQL、PostgreSQL 或 Redis,请提前创建服务并确认网络连通。

推荐操作顺序

  1. 完成首次安装:选择数据库、缓存与发号器,并创建管理员。
  2. 登录管理后台:使用管理员账号或已配置的 OIDC 登录。
  3. 创建首个域名与短链接:添加访问域名,创建并验证短链。

完成后,管理后台会在工作台展示短链数量和访问数据。

安装完成后的工作台

完成标准

  • 可以进入 /admin/ 并看到工作台。
  • 域名列表中至少有一个启用状态的域名。
  • 短链接列表中至少有一条启用状态的短链。
  • 通过反向代理访问时,应用收到的 Host 与后台域名记录完全一致。
  • 在无登录状态的浏览器窗口访问短链,可以跳转到目标 URL。

如果最后一步失败,优先检查请求 Host、域名解析、反向代理、协议配置、短链启用状态和过期时间。宝塔用户参阅宝塔面板安装教程