Obsidian Stats logoObsidian Stats

Remote Vault Sync

by suneater-labs
5
4
3
2
1
Score: 35/100
Install Code

Description

This plugin has not been manually reviewed by Obsidian staff. Back up and sync your vault to S3 with git-based version control.

Reviews

No reviews yet.

Stats

stars
downloads
0
forks
1
days
NaN
days
NaN
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

Invalid date

Changelog

See all version on GitHub

README file from

Github

Remote Vault Sync

Back up and sync your vault to S3 with git-based version control.

How It Works

Uses native git via child_process. The .git directory is copied to/from S3 directly. Uses LFS to store large files in S3.

Files

src/
  main.tsx           → Plugin entry, orchestrates git/S3/UI
  commands.ts        → Command palette commands
  settings.tsx       → Settings tab and defaults
  ui/
    StatusBar.tsx    → Status bar component
    RibbonButtons.ts → Push/Pull/Restore ribbon icons
    LogModal.tsx     → Commit history modal
    DiffModal.tsx    → View changes modal
    MergeModal.tsx   → Conflict resolution modal
  utils/
    git.ts           → Native git wrapper (child_process)
    lfs.ts           → Git LFS utilities
    env.ts           → Environment setup for GUI apps
    s3.ts            → S3 client wrapper
    s3-fs.ts         → S3 filesystem operations

Prerequisites

Requires git and git-lfs installed on your system.

Windows:

winget install --id Git.Git -e --source winget
winget install --id GitHub.GitLFS -e --source winget

macOS:

brew install git git-lfs

Linux (Debian/Ubuntu):

sudo apt install git git-lfs

After installing, run once:

git lfs install

Setup

  1. Create an S3 bucket
  2. Create AWS credentials with S3 read/write access
  3. Open plugin settings, enter credentials (access key, secret, region, bucket)
  4. Click Connect
    • If the bucket already has a repo, it pulls it down
    • If empty, it initializes a new git repo

Usage

Ribbon buttons:

  • Push — Commits changes, merges remote if diverged, uploads .git to S3
  • Pull — Downloads .git from S3, merges into local
  • Restore — Discards local changes (git restore)

Commands:

  • Push to Remote
  • Pull from Remote
  • Restore Changes
  • Show Log
  • View Changes

S3 Storage Layout

s3://bucket/
  .git/                     → git repository (mirrored from local)
    lfs/objects/AB/CD/...   → LFS objects (sharded by SHA256)

Status Bar

Shows current state: synced, uncommitted changes, syncing, or error.

Build

npm install
npm run build

npm run lint          # Check for errors
./scripts/install.sh  # Install to test vault
Sponsors