The Easiest Way to Setup Obsidian Git (to backup notes)

Share & showcase
1

I watched a few videos on how to setup the obsidian-git plugin and it feels like most of them overcomplicate the process. So I decided to write a set of instructions and a video to show how easy it to accomplish this even if you have no idea what “git” is.

By the end of this tutorial, you will be able to sync your notes from Obsidian to Github for free!

  1. Create a repository or fork the md repo in github
  2. Download Git
  3. Create a personal access token from githubcreate-pat-github.png
  4. Install the Obsidian Git community plugin
  5. Create a folder to store the repository. (e.g. remote-blog/). Set scopes to repo & expiration to no expiration
  6. Run the command (CMD/Ctrl + P): Clone an existing remote repo clone-repo-git-plugin.png
  7. Paste the URL of the forked repository in the following format
https://<PERSONAL_ACCESS_TOKEN>@github.com/<USERNAME>/<REPO>.git

For example it might look like this:

https://[email protected]/ithinkwong/linked-blog-starter-md.git
  1. Then type in the folder you created in step 5 (e.g. remote-blog/)
  2. Restart Obsidian
  3. Make edits to your notes
  4. Publish your notes run the command “Obsidian Git: Create backup” by opening the command palette (CMD/Ctrl + P)
16 Likes
2

I tried this on my friends iPad but during the last steps it failed.
I think 7 or 8.

The error is that it does not show any files or folders.

Without showing any failure iin a popup.

I will investigate further but maybe you have an idea.

The first thing I have to google is how to activate the logs on iPad (I think I did it once…)

1 Like
3

Yes my git cloning failed on iPad too. Always aborting at some point of the directories.

2 Likes
4

I’ve only tested it on desktop versions. I think the mobile version of git is a different setup unfortunately. :frowning:

2 Likes
5

I have a mobile setup version here, it’s quick way and working:
Setup obsidian-git on multiple devices

6

Here are 7 steps to create a live vault:

  • Create a vault using desktop app.
  • Install obsidian-git community plugin inside the vault.
    Settings > Community Plugins > Search
  • Create a github account or skip if you have one.
  • Create new repository with README . (ex. you/notes)
  • Create a fine-granted access token to access the repo. here
  • Change to vault directory and clone using the access token.
    git clone https://<token>@github.com/you/notes.git
  • Copy the vault folder to your mobile device.
  • Finally restart Obsidian and you are good to go!

Optional:

  • Take a look at Settings > Obsidian Git.
  • Define your hotkeys in settings.
2 Likes
7

What if you’ve already set this plugin up using another form of authentication (HTTPS/SSH)?

Assuming you already have the repo cloned somewhere, we’re going to edit the file .git/config. These instructions should work on UNIX based systems.

  1. Open a terminal
  2. Navigate to your repo, ie cd <repo_name>
  3. Open the file using your editor of choice, ie vim .git/config or nano .git/config (easier).
  4. Find the line that starts with url =, update it to reflect the instructions above.
  5. Save and close the file.
  6. Restart Obsidian.
8

Did this work for anyone at all? I cannot get it to push to github. Im getting 403 error

9

Are they any recommended settings to automatically push and pull changes? Basically I want Obisidian to sync with github automatically.

Thanks!

10

I’m driving Linux, but this will work on Mac if you are comfortable with the terminal.

I have my laptop connected to Github via SSH. I then re-cloned my GH repo for my vault using SSH instead of HTTPS. Now it pulls/pushes without prompting for uname/passwd.

11

I was getting this error and I couldn’t push or pull any changes:

Your branch is based on 'origin/main', but the upstream is gone.

Fixed using:

git branch --unset-upstream
git push --set-upstream origin main
12

Hey ithinkwong,

Thanks for your helpfull thread. I think there’s a mistake here at 5.
“Set scopes to repo & expiration to no expiration”
should be after :
“3. Create a personal access token from github”

13

It happened to me. Maybe you didn’t set “repo” when creating the token, the note in Github documentation (managing your personal access tolkens):
Note

Organization owners can restrict the access of personal access token (classic) to their organization. If you try to use a personal access token (classic) to access resources in an organization that has disabled personal access token (classic) access, your request will fail with a 403 response. Instead, you must use a GitHub App, OAuth app, or fine-grained personal access token.