Skip to content

feat(conf,server,db): add config file hot-reload without restart - #2923

Closed
Warm-winter wants to merge 5 commits into
OpenListTeam:mainfrom
Warm-winter:feat/config-hot-reload
Closed

feat(conf,server,db): add config file hot-reload without restart#2923
Warm-winter wants to merge 5 commits into
OpenListTeam:mainfrom
Warm-winter:feat/config-hot-reload

Conversation

@Warm-winter

@Warm-winter Warm-winter commented Aug 13, 2026

Copy link
Copy Markdown

Summary / 摘要

This PR implements hot-reload for config.json, allowing most configuration changes to take effect without restarting the OpenList server. Previously, modifying fields such as scheme.*, s3.*, ftp.*, sftp.*, mcp.enable, cors.*, max_connections, dist_dir, database, and search engine settings required a full service restart.

此 PR 为 config.json 实现热重载机制，使绝大多数配置变更无需重启服务即可生效。此前修改 scheme.*、s3.*、ftp.*、sftp.*、mcp.enable、cors.*、max_connections、dist_dir、数据库及搜索引擎等设置均需完整重启服务。

  • 新增基于 fsnotify 的配置文件监听器（SHA-256 去重 + 150ms 防抖）

  • 新增离线重载引擎，原子交换全局配置指针并应用副作用

  • 将 MCP/S3 路由改为始终注册 + 请求期守卫中间件，支持启用状态即时切换

  • 将 CORS / max_connections / force_https 中间件改为请求期实时读取配置

  • 抽取 HTTP/HTTPS/HTTP3/Unix/S3/FTP/SFTP 监听器为可独立启停的函数，配置变化时仅重启受影响端点

  • 支持数据库、搜索引擎（bleve/meilisearch）、静态资源目录的子系统重初始化

  • 新增 glebarez 纯 Go sqlite 驱动作为 cgo 不可用时的回退，支持 CGO_ENABLED=0 交叉编译

  • 修复 Dockerfile 在 Windows 检出下因 CRLF 行尾导致的 bash 解析错误

  • This PR has breaking changes.

    / 此 PR 包含破坏性变更。

  • This PR changes public API, config, storage format, or migration behavior.

    / 此 PR 修改了公开 API、配置、存储格式或迁移行为。

（说明：配置热重载改变配置变更的生效方式，但不改变配置字段格式或默认行为；纯 Go sqlite 驱动切换通过 build tag 自动进行，对用户透明）

  • This PR requires corresponding changes in related repositories.

    / 此 PR 需要关联仓库同步修改。

Related repository PRs / 关联仓库 PR:

  • OpenList-Frontend: N/A

  • OpenList-Docs: 可选——建议补充热重载机制说明文档

Related Issues / 关联 Issue

N/A（无直接关联 Issue；如需要可创建 feature request issue 关联）

Testing / 测试

  • go test ./...

  • Manual test / 手动测试:

测试环境：WSL Ubuntu-24.04 + Docker v29.3.1，OpenList v4.2.5

  1. Docker 镜像构建：使用项目 Dockerfile 构建 openlist:local 镜像（151MB），/ping 返回 pong，版本信息正确

  2. MCP 热重载验证：容器内修改 config.json 的 mcp.enable：

    • false → GET /mcp 返回 {"code":403,"message":"MCP server is not enabled"}

    • 改为 true → 返回 {"code":401,"message":"Guest user is disabled, login please"}（守卫通过，进入认证）

    • 改回 false → 再次返回 403

    • 全程无需重启容器，2 秒内生效

  3. 浏览器全量功能测试（6 项全部通过，无控制台错误）：

    • 首页加载、admin 登录、文件列表、存储管理页、设置页、MCP 路由守卫

  4. 多平台交叉编译：Windows amd64（PE32+）、macOS amd64/arm64（Mach-O）、Linux musl amd64/arm64（静态链接 ELF）均通过 file 命令验证

测试截图和详细日志见本地验证记录（未随 PR 提交）。

Checklist / 检查清单

  • I have read https://github.com/OpenListTeam/OpenList/blob/main/CONTRIBUTING.md .

    / 我已阅读  https://github.com/OpenListTeam/OpenList/blob/main/CONTRIBUTING.md  。

  • I confirm this contribution follows the repository license, contribution policy, and code of conduct.

    / 我确认此贡献符合仓库许可证、贡献规范和行为准则。

  • I have formatted the changed code with gofmt, go fmt, or prettier where applicable.

    / 我已按适用情况使用 `gofmt`、`go fmt` 或 `prettier` 格式化变更代码。

  • I have requested review from relevant maintainers or code owners where applicable.

    / 我已在适用情况下请求相关维护者或代码所有者审查。

AI Disclosure / AI 使用声明

  • This PR includes AI-assisted content.

    / 此 PR 包含 AI 辅助内容。

Tools used / 使用工具:

  • ChatGPT

  • Codex

  • GitHub Copilot

  • Claude

  • Other (please specify) / 其他（请注明）: Co-authored-by: DeepSeek-V4-PRO-0813 noreply@deepseek.com
    （通过 DeepSeek Harness 辅助开发）

Usage scope / 使用范围:

  • Code generation / 代码生成

  • Refactoring / 重构

  • Documentation / 文档

  • Tests / 测试

  • Translation / 翻译

  • Review assistance / 审查辅助

  • I have reviewed and validated all AI-assisted content included in this PR.

    / 我已审核并验证此 PR 中的所有 AI 辅助内容。

  • I have ensured that all AI-assisted commits include Co-Authored-By attribution.

    / 我已确保所有 AI 辅助提交都包含 `Co-Authored-By` 归属信息。

  • I can reproduce all AI-assisted content included in this PR without any AI tools.

    / 我可以在没有任何 AI 工具的情况下重现此 PR 中包含的所有 AI 辅助内容。

Warm-winter and others added 5 commits August 14, 2026 03:01
@Warm-winter DeepSeek-V4-PRO-0813
feat(conf): add config file hot-reload with fsnotify watcher
2c76e3e 
- Add fsnotify-based watcher in internal/conf/watcher.go to monitor
  config.json changes with SHA-256 dedup and 150ms debounce
- Add reload engine in internal/bootstrap/reload.go that rebuilds the
  config offline and atomically swaps the global config pointer
- Wire watcher startup and shutdown into bootstrap run lifecycle
- Extract HTTP/HTTPS/HTTP3/Unix/S3/FTP/SFTP endpoint start logic into
  independently restartable functions, restarting only affected
  endpoints on scheme/s3/ftp/sftp config changes
- Apply side effects for hot-reloadable fields without restart

Co-authored-by: DeepSeek-V4-PRO-0813 <noreply@deepseek.com>
@Warm-winter DeepSeek-V4-PRO-0813
feat(server): enable hot-reload for MCP and S3 route guards
af049c5 
- Register MCP routes unconditionally and guard with request-time
  middleware that reads conf.Conf.MCP.Enable, returning 403 when
  disabled to match prior placeholder behavior
- Apply the same guard pattern to S3 routes on the main HTTP server
  so s3.enable toggles take effect without restart
- Read CORS, max_connections, and force_https settings at request
  time in middlewares instead of baking them into gin handlers

Co-authored-by: DeepSeek-V4-PRO-0813 <noreply@deepseek.com>
@Warm-winter DeepSeek-V4-PRO-0813
feat(server): support hot-reload of subsystems
656938f 
- Reinitialize database connection when database config changes
- Reinitialize bleve and meilisearch search engines on config changes
- Reload static dist_dir when dist_dir config changes
- Add graceful delayed shutdown for old instances

Co-authored-by: DeepSeek-V4-PRO-0813 <noreply@deepseek.com>
@Warm-winter DeepSeek-V4-PRO-0813
feat(db): add pure-Go sqlite driver fallback for cross-compilation
ae52941 
- Add internal/db/sqlite_driver_glebarez.go using glebarez/sqlite
  (pure Go) as default when sqlite_cgo_compat tag is absent
- Add internal/db/sqlite_driver_gorm.go using gorm sqlite (cgo) under
  sqlite_cgo_compat tag or legacy platforms (mips/loong64/win386)
- Enable CGO_ENABLED=0 cross-compilation for Windows/macOS/Linux-musl

Co-authored-by: DeepSeek-V4-PRO-0813 <noreply@deepseek.com>
@Warm-winter DeepSeek-V4-PRO-0813
fix(docker): convert CRLF line endings in build scripts
be336ba 
- Add sed CRLF-to-LF conversion for build.sh and entrypoint.sh in
  Dockerfile builder stage to fix bash parse errors on Windows checkouts
- Apply the same conversion to entrypoint.sh in the runtime stage

Co-authored-by: DeepSeek-V4-PRO-0813 <noreply@deepseek.com>
@github-actions

github-actions Bot commented Aug 13, 2026

Copy link
Copy Markdown

⚠️ PR 标题需以 feat(): , docs(): , fix(): , style(): , refactor(): , chore(): 其中之一开头，例如：feat(component): 新增功能。
⚠️ The PR title must start with feat(): , docs(): , fix(): , style(): , or refactor(): , chore(): . For example: feat(component): add new feature.

如果跨多个组件，请使用主要组件作为前缀，并在标题中枚举、描述中说明。
If it spans multiple components, use the main component as the prefix and enumerate in the title, describe in the body.

如果是破坏性变更，请在类型后添加 !，例如 feat(component)!: 破坏性变更。
For breaking changes, add ! after the type, e.g., feat(component)!: breaking change.

@Warm-winter Warm-winter changed the title Feat/config hot reload feat(conf,server,db): add config file hot-reload without restart Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Warm-winter