Home

⚠️ Warning This version is outdated. Please refer to the documentation here

Obsidian-Git Documentation

• Installation
• Common issues
• Tips and Tricks

Requirements

• Credentials are set up
• Remote repository

SSH-Authentication

This is a typical example of a trade-off between security and convenience. [...] The most appropriate solution depends on the usage scenario and desired level of security.

If you want to use SSH and have a passphrase for your ssh-key, you have to add it to the ssh-agent so that Obsidian can access it. Read more at this summary to start ssh-agent on system startup.

Submodules Support

Since version 1.10.0 submodules are supported. While adding/cloning new submodules is still not supported (Might come later), updating existing submodules on the known "Create Backup" and "Pull" commands is supported. This works even recursively. "Create Backup" will cause to add, commit and push (if turned on) all changes in all submodules. This feature needs to be turned on in the settings.

Additional requirements:

• Checked out branch (not just a commit as it is when running git submodule update --init)
• Tracking branch is set up, so that git push works
• Tracking branch needs to be fetched, so that a git diff with the branch works