Config export and import: back up and restore the PaperPi config
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 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 の本文から書いたものです。
説明
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)
- 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.
- Only the configuration. Plugin files (plugin storage folders, slideshow pictures, outside plugins from #326) are not copied. Export warns about this clearly.
- 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.
- Config versions: configs should keep working between minor versions of PaperPi. At a major version, import checks the file's
config_versionand tries to upgrade it. Handling major-version imports is low priority for now. (This is not about v1paperpi.inifiles; that is #248.) - 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. - 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) andpaperpi 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時間 55分
- マージ済み PR（30日）
- 77
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
txoof/PaperPi のほかの issue
-
Plugins whose default refresh equals the display time (word_clock, system_info, nl_openbaar_vervoer)対応中かも @txoof-bot が今日担当しました。 オープンarea:plugins in-progress
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
txoof/PaperPi#335 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
area:web enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 56/100
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
nansencenter/geodataset#39 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
awslabs/visual-asset-management-system#804 ·
メンテナーはふだん 1 日以内に返信
-
follow-up
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
link-rot
難易度 1/5 1時間未満 初心者へのやさしさ 67/100