Add Backup page, link from Home

Pavel Baksy 2026-05-27 16:46:03 +02:00
parent 8c21b0bef0
commit b422105976
2 changed files with 46 additions and 0 deletions

45
Backup.md Normal file

@ -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.

@ -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 - [[Sensitive-Variables]] - Secure storage with GNOME Keyring
- [[Scripts]] - Preprocessing and postprocessing automation - [[Scripts]] - Preprocessing and postprocessing automation
- [[Export]] - Export requests to other tools - [[Export]] - Export requests to other tools
- [[Backup]] - Back up and manage project data
- [[History]] - Track and replay requests - [[History]] - Track and replay requests
- [[Import]] - Import from OpenAPI/Swagger and WSDL - [[Import]] - Import from OpenAPI/Swagger and WSDL