Config export and import: back up and restore the PaperPi config

未关闭
  • 哪里不对？
#328 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
45/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
python

调研方向

Start with docs/decisions/config-format.md and the existing config check and save paths; also read the related issues #248 and #272 for version handling and reload behavior. Then map the CLI and settings page entry points for import and export. Done means validated imports preserve the current config on failure, keep a recoverable backup, apply successfully, and exports clearly warn about included secrets and excluded plugin files.

由索引模型根据 Issue 内容生成。

描述

area:core area:web enhancement

What

A way to back up the PaperPi configuration and put it back later, for example after a fresh install, on a new SD card, or to copy a setup to a second frame.

  • Export: save the current config as one file.
  • Import: load such a file, check it, and use it as the new config.

Why

All settings live in one TOML file (docs/decisions/config-format.md). Today the only way to back it up is to copy that file by hand over SSH, and only root and the PaperPi service can read it. A built-in export and import makes this easy and safe for people who don't use the command line.

Decisions (txoof, 2026-10-25)

  1. Secrets are included. The export holds the web password and plugin API keys. Every export path shows an explicit warning: the file contains passwords and keys, so keep it somewhere safe and don't share it.
  2. Only the configuration. Plugin files (plugin storage folders, slideshow pictures, outside plugins from #326) are not copied. Export warns about this clearly.
  3. Plugin IDs stay the same. Each frame has its own storage, so two frames with the same IDs don't get in each other's way, and importing on the same frame reuses the plugins' existing storage folders.
  4. Config versions: configs should keep working between minor versions of PaperPi. At a major version, import checks the file's config_version and tries to upgrade it. Handling major-version imports is low priority for now. (This is not about v1 paperpi.ini files; that is #248.)
  5. Missing plugins: a plugin block whose plugin is not installed on this frame is still imported, but switched off (enabled = false). Import lists these plugins in a warning with a hint on how to install them. Once the plugin is installed, the user can switch the block back on.
  6. Both on the disk and over the web. Export can save to the local disk or download through the web interface. Import works the same way: from a file on the local disk or uploaded through the web interface.

Scope

  • Command line: paperpi config export [-o FILE] (local disk) and paperpi config import FILE.
  • Web interface: Export (download) and Import (upload) on the settings page, plus an option to save to and load from a file on the frame's disk.
  • Import runs the normal config check before the file is used. A bad file is refused with a clear message, and the current config is not changed.
  • Import keeps a copy of the old config, so a wrong import can be undone.
  • Import is written safely (temporary file, then replace in one step), like every other config save.
  • After import, the new config is applied the same way as paperpi reload (#272).
  • The exported file is only readable by its owner when it is saved on the frame (same as the config file).

Related: #248 (v1 → v2 tool), #272 (paperpi reload), #326 (outside plugin folder).

🤖 Generated with Claude Code

主要语言
Python
星标
205
派生
17
平均合并
3 小时 49 分钟
30 天内合并 PR
89

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

txoof/PaperPi 的其他 Issue

查看 txoof/PaperPi 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。