From b422105976196f5900dbf8a36f250b26221138cb Mon Sep 17 00:00:00 2001 From: Pavel Baksy Date: Wed, 27 May 2026 16:46:03 +0200 Subject: [PATCH] Add Backup page, link from Home --- Backup.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ Home.md | 1 + 2 files changed, 46 insertions(+) create mode 100644 Backup.md diff --git a/Backup.md b/Backup.md new file mode 100644 index 0000000..9b21c6f --- /dev/null +++ b/Backup.md @@ -0,0 +1,45 @@ +# Backup & Data folder + +## Where data is stored + +Roster stores all projects and requests as plain JSON files: + +``` +~/.local/share/cz.bugsy.roster/projects/ (native) +~/.var/app/cz.bugsy.roster/data/cz.bugsy.roster/projects/ (Flatpak) + my-api/ + _project.json ← project metadata + get-users.json ← one file per request + create-user.json + another-project/ + _project.json + health-check.json +``` + +Each request is a self-contained JSON file. This makes the data folder suitable for version control — you can run `git init` there yourself and commit, diff, or share individual requests. + +## Opening the data folder + +**Preferences → Data → Data folder → Open** + +Opens the data folder in the system file manager. From there you can inspect files, run `git init`, or copy the folder manually. + +## Backup + +Backup copies the entire `projects/` directory to `{backup folder}/roster-backup/`. + +### Manual backup + +1. Open **Preferences → Data** +2. Under **Backup folder**, click **Choose…** and select a destination +3. Click **Backup** to copy files immediately + +### Auto-backup on save + +Enable **Auto-backup on save** in **Preferences → Data**. After each save Roster copies all project files to the backup folder automatically. + +> **Note:** Backup is additive — files removed from Roster are not deleted from the backup folder. To get a clean snapshot, delete `roster-backup/` manually before clicking Backup. + +## Migration from previous versions + +On first launch after upgrading, Roster automatically converts the old `requests.json` file to the new per-file format. The original file is kept as `requests.json.bak` in the data folder. diff --git a/Home.md b/Home.md index 1f954b2..0c725c7 100644 --- a/Home.md +++ b/Home.md @@ -25,6 +25,7 @@ Roster is a native GNOME application for testing and debugging HTTP APIs with su - [[Sensitive-Variables]] - Secure storage with GNOME Keyring - [[Scripts]] - Preprocessing and postprocessing automation - [[Export]] - Export requests to other tools +- [[Backup]] - Back up and manage project data - [[History]] - Track and replay requests - [[Import]] - Import from OpenAPI/Swagger and WSDL