2.4 KiB
| aliases | |
|---|---|
|
Important
Although the plugin itself is desktop platform independent, an incorrect installation of Obsidian or Git may break the plugin.
Plugin installation
From within Obsidian
Go to "Settings" -> "Community plugins" -> "Browse", search for "Git", install and enable it.
Manual
- Download
obsidian-git-<latest-version>.zipfrom the latest release - Unpack the zip in
<vault>/.obsidian/plugins/obsidian-git - Restart Obsidian
- Go to settings and disable restricted mode
- Enable
Git
Windows
Installing GitHub Desktop is not enough! You need to install regular Git as well.
Git installation
[!info] Ensure you are using Git 2.29 or higher.
Install Git from the official website with all default settings.
Make sure you have 3rd-party software access enabled.
!
Enable Git Credential Manager. You can verify this for existing installations by executing the following. It should ouput manager.
git config credential.helper
!
Linux
Obsidian installation
Known supported Obsidian installation methods:
- AppImage
Known not fully supported package managers
- Snap (Snap puts Obsidian in a kind of sandbox, so that Obsidian can't access Git)
- Flatpak can access Git, but not all system files, so it's not recommended.
If you installed Obsidian a while ago via Flatpak, and it doesn't work, please run the following snippet.
$ flatpak update md.obsidian.Obsidian
$ flatpak override --reset md.obsidian.Obsidian
$ flatpak run md.obsidian.Obsidian
MacOS
Git Installation
In order to install git on your Mac Computer please follow a suitable route explained in the Official Git documentation
Keychain
Run the following to use the macOS keychain to store your credentials.
git config --global credential.helper osxkeychain
[!info] You have to complete a single authenticated action (either clone, pull or push) after setting the helper in the terminal. Once done, you should be able to sync Obsidian without any issues.