feat!: add system initialization (setup wizard) support - #3041
Open
PIKACHUIM wants to merge 2 commits into
Open
Conversation
|
如果跨多个组件,请使用主要组件作为前缀,并在标题中枚举、描述中说明。 如果是破坏性变更,请在类型后添加 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR: 系统初始化(安装向导)功能
概述 / Overview
Go 后端与 TS 后端实现同一套公开 API,前端仅需对接一套接口即可同时支持两种后端。
Summary / 摘要
为 OpenList 增加**系统初始化(安装向导)**能力。首次部署时不再自动创建随机密码的管理员账号,而是通过 Web 安装向导引导用户设置管理员账号、密码与站点名称,完成后再进入登录流程。此举消除「首次启动密码只打印在日志里」这一易被忽略的安全隐患,同时提供一致的首次部署体验。
设计 / Design
行为变更 / Behavior Change
admin账号,前端会检测「未初始化」状态并自动跳转到/@init安装向导。bootstrap/data/initUser拆分为initAdmin+initGuest;未初始化且未设置OPENLIST_ADMIN_PASSWORD、非--dev模式时,initAdmin直接返回,不再自动创建管理员。server/handles/setup.go,实现InitStatus与InitSetup两个 handler。GET /api/public/init_status与POST /api/public/init/setup。OPENLIST_ADMIN_PASSWORD环境变量或--dev模式时仍自动初始化(保持现有部署/CI 行为不变);数据库表创建(GORM AutoMigrate)逻辑不变。admin+ 随机密码(打印到日志)/@initOPENLIST_ADMIN_PASSWORD(Go)/ADMIN_PASSWORD(TS)--dev)admin/admin/ 此 PR 包含破坏性变更。
/ 此 PR 修改了公开 API、配置、存储格式或迁移行为。
/ 此 PR 需要关联仓库同步修改。
新增公开 API / New Public API
Related repository PRs / 关联仓库 PR:
/api/public/init_status{ initialized: boolean },前端据此判断是否跳转安装向导/api/public/init/setup{ username, password, site_title }feat/init-setup(安装向导页面,待创建 PR)main(afabd9b),非 PR初始化判定标准:存在已设置密码的管理员账号(
role = admin)。Related Issues / 关联 Issue
改动清单 / Changes
不适用 / Not applicable.
1. Go 后端(
OpenList-Backends)Testing / 测试
internal/bootstrap/data/user.goinitUser拆分为initAdmin+initGuestinitAdmin:未初始化且非 Dev、未设置OPENLIST_ADMIN_PASSWORD时直接返回,不再自动创建管理员server/handles/setup.go(新增)InitStatus:读取 admin 是否存在,返回初始化状态InitSetup:校验已初始化状态与密码长度(≥4),创建管理员并写入站点名称设置项(conf.SiteTitle)server/router.goGET/POST /api/public/init_status与POST /api/public/init/setup2. TS 后端(
OpenList-TSWorker)go build ./...(通过)go test ./...(未运行,本改动无新增单测,建议合并前执行)Manual test / 手动测试:
OPENLIST_ADMIN_PASSWORD)→ 前端应自动跳转/@init安装向导OPENLIST_ADMIN_PASSWORD后部署 → 跳过向导,直接用该密码登录(兼容性)--dev模式 → 仍自动创建admin/adminserver/auth.tsgetOrInitUsers:未设置ADMIN_PASSWORD时不再生成随机密码,仅创建 guest,admin 交由安装向导username === "admin"统一改为role === 2(支持自定义管理员用户名)server/public.tsGET /api/public/init_status与POST /api/public/init/setupserver/default_credentials.test.tsChecklist / 检查清单
3. 前端(
OpenList-Frontend)I have read CONTRIBUTING.
/ 我已阅读 CONTRIBUTING。
I confirm this contribution follows the repository license, contribution policy, and code of conduct.
/ 我确认此贡献符合仓库许可证、贡献规范和行为准则。
I have formatted the changed code with
gofmt,go fmt, orprettierwhere applicable./ 我已按适用情况使用
gofmt、go fmt或prettier格式化变更代码。I have requested review from relevant maintainers or code owners where applicable.
/ 我已在适用情况下请求相关维护者或代码所有者审查。
pages/init/index.tsx(新增)app/App.tsx/@init路由init_status,未初始化自动跳转/@initlang/en/init.json+lang/en/entry.tsAI Disclosure / AI 使用声明
graph TD A[访问站点] --> B{GET /api/public/init_status} B -->|initialized = true| C[正常登录流程] B -->|initialized = false| D[跳转 /@init 安装向导] D --> E[填写管理员账号/密码/站点名称] E --> F{POST /api/public/init/setup} F -->|成功| G[跳转登录页] F -->|已初始化/校验失败| D/ 此 PR 包含 AI 辅助内容。
Tools used / 使用工具:
测试 / Testing
ChatGPT
Codex
GitHub Copilot
Claude
Gemini
Other (please specify) / 其他(请注明): Deepseek-V4-Pro (CodeBuddy)
Go 后端:
go build ./...通过TS 后端:更新后的
default_credentials.test.ts覆盖新行为(未初始化不自动建 admin、空密码保持为空)前端:lint 通过
手动验证:
ADMIN_PASSWORD/OPENLIST_ADMIN_PASSWORD)→ 首页应自动跳转/@initADMIN_PASSWORD/OPENLIST_ADMIN_PASSWORD后部署 → 跳过向导,直接用该密码登录(兼容性)Usage scope / 使用范围:
提交方式 / Submission
OpenList-TSWorkermainOpenList-Backendsfeat/init-setupmain)OpenList-Frontendfeat/init-setupmain)Checklist
/ 我已审核并验证此 PR 中的所有 AI 辅助内容。
Co-Authored-Byattribution./ 我已确保所有 AI 辅助提交都包含
Co-Authored-By归属信息。/ 我可以在没有任何 AI 工具的情况下重现此 PR 中包含的所有 AI 辅助内容。