backuproost
v0.1.1
Published
Automatic Notion backup — nightly sync of your workspace to diffable Markdown + raw JSON, self-hosted, free
Maintainers
Readme
BackupRoost
Automatic Notion backup to GitHub or an Obsidian vault. Free, open-source, self-hosted — your data never touches a third party.
Notion has no official scheduled backup, version history is capped by plan tier, and trash purges after 30 days. BackupRoost continuously syncs every page shared with your integration into diffable Markdown (plus raw JSON for fidelity), so git history becomes your unlimited version history.
Quick start
- Create a Notion internal integration at notion.so/profile/integrations and copy the token.
- Grant it access to the top-level pages you want backed up (connection settings → Content access; access cascades to sub-pages).
- Run:
NOTION_TOKEN=secret_xxx npx backuproost sync --out ./backupRuns are incremental: only pages edited since the last run are re-fetched. A run exits non-zero unless every page was synced and verified on disk, so it's safe to script against.
No terminal? No machine? The GitHub Actions template backs up your workspace nightly into a private GitHub repo — set up entirely by clicking, free.
From source: npm install && npm run build && node dist/cli.js sync --out ./backup.
Output layout
backup/
pages/<title-slug>-<id>/<Page Title>.md # page content as Markdown, named after the page
pages/<title-slug>-<id>/page.json # raw page object (properties, metadata)
data-sources/<id>.json # database/data-source schemas
manifest-latest.json # report of the last run
state.json # incremental sync baselineDeleted or unshared pages are never silently removed — they're reported in the manifest and their files kept.
Project docs
- vault/PLAN.md — architecture, roadmap, milestones
- vault/RESEARCH.md — landscape research: existing tools, Notion API limits, data-loss patterns
Status
CLI MVP done and verified: incremental sync with per-run completeness validation (every page proved on disk, ok flag in the manifest). Next per the plan: template repo + npm launch, Obsidian vault renderer, attachment download, restore.
License
MIT
