PluginCommunity Plugin

Obsidian Git

Back up your Obsidian vault automatically to GitHub, GitLab, or Gitea with version control.

by VinzentSync & Backup

Vinzent is credited as the original plugin creator. Setup notes, fit assessments, and cautions below are Obsidian Mate editorial guidance. How we review resources

syncbackupgitversion controlprivacy

Overview

Obsidian Git automates vault backups using Git version control. Developed by Vinzent, it allows you to automatically commit and push your notes to a remote repository (like GitHub or GitLab) on a customizable interval. It gives you full version history, diff viewing, and automatic disaster recovery.

Key Features

How to Install Obsidian Git

  1. 1Ensure Git is installed on your computer and your vault is initialized as a Git repository.
  2. 2Open Settings, then Community plugins, search for "Obsidian Git", install and enable it.
  3. 3Open Obsidian Git settings and configure auto-commit and push intervals.
  4. 4Use command palette (Ctrl/Cmd + P) to run "Obsidian Git: Commit all and push".

How to Use Obsidian Git

Start with manual pull, commit, and push commands until authentication and conflict handling work. Then enable an automatic interval that fits how often the vault changes. A ten-minute interval is a reasonable desktop starting point, but large repositories may need longer.

Use a private remote for personal notes and review .gitignore before the first push. Git records history; it does not encrypt note contents or make a public repository private.

A Safer First-Backup Workflow

  • Install regular Git on desktop; GitHub Desktop alone does not satisfy the Windows requirement in the official guide.
  • Create or clone a private remote, authenticate in the terminal, and confirm one manual pull and push before enabling automation.
  • Commit a test-note change, verify it remotely, then restore an earlier version so recovery is familiar before an emergency.
  • Pull before editing on another device and push when finished. Git supports asynchronous synchronization, not live co-editing.

Example .gitignore

Workspace files change frequently and are device-specific, so many vaults exclude them while retaining settings meant to travel between desktops. Decide separately whether large attachments belong in Git.

.gitignore
.obsidian/workspace.json
.obsidian/workspace-mobile.json
.trash/
.DS_Store

Mobile and Conflict Limitations

  • The official guide describes the mobile implementation as unstable and recommends alternatives when reliability matters.
  • Mobile uses isomorphic-git: SSH authentication, rebase, and submodules are unsupported, and repository size is constrained by memory.
  • Automatic pulls can conflict with independently edited notes. Keep another backup and learn to inspect conflict markers.
  • Linux Snap and Flatpak packaging can prevent Obsidian from reaching the system Git installation.

Repository Screenshots & Visual Preview

Rich preview screenshots and visual assets extracted directly from the official GitHub repository for Obsidian Git:

Obsidian Git source-control view listing changed vault files
The plugin's source-control view exposes changed files and Git actions inside Obsidian.

Details

GitHub stars
8k+

Frequently Asked Questions

Does Obsidian Git work on iOS/Android?

The plugin includes a mobile implementation based on isomorphic-git, but its official guide calls mobile support unstable. SSH authentication, rebase, and submodules are unavailable there, and large repositories may exceed device memory.

Will my notes remain private on GitHub?

Yes, as long as you create a Private Repository on GitHub or GitLab.

Sources and Documentation

This guide was checked against the creator's repository and primary documentation.

Related Obsidian Plugins

Related Guides

Explore more Obsidian resources

Discover more plugins, themes, templates, and starter vaults to build your perfect Obsidian setup.