Setup Obisidian Git on Desktop

Important

Prerequisites

• Obsidian installed on your desktop (Download Obsidian).
• GitHub Desktop installed (Download GitHub Desktop).
• A GitHub account (Create an account).
• Completed the Beginner's Guide

Clone the Repository with GitHub Desktop

1. Open GitHub Desktop.
2. Login and authenticate with oAuth (or your preferred method)
3. Go to File > Clone Repository.
4. Select the newly created repository and choose a local directory for the repository (e.g., ~/Documents/my-obsidian-vault).
5. Click Clone.

Set Up Obsidian

1. Open Obsidian.
2. Click Open folder as vault and select the local folder you cloned using GitHub Desktop.

Install Obsidian-Git Plugin

1. Go to Settings > Community Plugins in Obsidian.
2. Turn on Safe Mode if it's off.
3. Click Browse and search for Obsidian Git.
4. Install and enable the Obsidian-Git plugin.

Configure Obsidian-Git

1. Go to Settings > Obsidian Git.
2. Set the following options:
   • Auto commit-and-sync interval (minutes): (e.g., 5 minutes).
   • Auto commit-and-sync after stopping file edits: Enabled.
   • Commit message on auto commit-and-sync: Customize or leave as default.
   • Pull on startup: Enabled.
   • Push on commit-and-sync: Enabled.
   • Pull on commit-and-sync: Enabled.
3. Save changes.

Step 7: Syncing Changes

• Pulling Changes: On startup, Obsidian-Git automatically pulls changes from GitHub.
• Pushing Changes: Obsidian-Git automatically commits and pushes changes based on the set interval.

Important

The plugin obsidian-git will interfere with GitSync, so you will need to disable it on your mobile devices!
This can easily be done by opening your Obsidian vault on your mobile device, scrolling to the bottom of the Git settings and enabling disable on this device

You’re now set up to sync your Obsidian vault on Desktop!