Backing up your obsidian vault on Github is a great way to keep and maintain ongoing backups of your Obsidian Vault. Github offers both public and private repositories for free, so it’s a good option if you want free backups for your Second Brain. There are many more options when it comes to backing up Obsidian, but Git is one of my favorites, because it has saved my notes many times.
However if you’re new to git or Github, the process can be a bit intimidating. Here’s one way to get this set up that should be straightforward for beginners and experts alike.
What are git and Github?
If you’re new to git, Github, or version control in general, here are a few important definitions:
- version control system: A software package that keeps a history of changes to any set of text files.
- git: A free and open source version control system.
- git repository: A folder of text files that uses git to keep track of its history.
- Github: a platform for hosting git repositories, with some social media-like features.
Many people get git and Github confused. git is free software that you can run on any computer. Github is a website that helps you use git. Even though Github is a software company, they still offer their services for free for most people, which is one reason why backing up your obsidian vault on Github can be such a good way to go.
There are two main downsides to backing up your Obsidian vault on Github:
- If you haven’t used git or Github before, there is a bit of a learning curve. Hopefully this article helps with that.
- You don’t control your own data. Microsoft owns Github, so even if you use a private repository, there’s no guarantee that they won’t data-mine your data.
If you’re worried about privacy, there are better options out there than Github. But it’s a great platform for all but the most sensitive information: it’s free, fast, and easy to use.
If Github still sounds like a good option to you, then let’s get started:
Step 1: Download an app
If you’ve never used git before, the easiest way is to use an app. Github Desktop is popular on Windows and Mac. If you want something fully cross platform, Sublime Merge is a lightweight and fast option (but not free). We’ll use Github Desktop for this tutorial, but the steps are similar no matter what app you use.
Step 2: Create a local repository
A git repository is a folder controlled by git. You can create a git repository out of any folder on your computer. In this case, you’ll want to create a git repository out of your Obsidian Vault.
If you’re using Github Desktop, this is a bit unintuitive. You’ll want to select “New Repository” from the File menu, and select the parent folder for your vault. Then type the exact name of your vault inside the “Name” field. That should look like this:
For example, if your Vault is named MyVault inside your “Documents” folder, select “Documents” and type “MyVault”. This won’t actually create a new folder, as long as you use the exact name of your existing folder.
Then click “Create Repository”. Github Desktop will then automatically commit all of your current files, creating your first “commit”.
What is a commit?
One more definition for you: a commit is a snapshot of a moment in time. When we created a repository using Github Desktop, the app automatically created your first commit. If you go to the History tab, you can even see your first commit:
On the left side of the screen, we can see the commit message, which says “Initial commit”. In the middle are all of the file changes (your list will be much longer, probably). If you click on one of the file names, the changes will show up on the right.
Every time you make a change to your git repository, you have to commit to that change with a commit. This is the backbone of git, and how you’re able to store and see the entire history of your files. We’ll walk through a commit in a minute, but first let’s get your Vault stored in Github.
Step 3: Save your vault to Github
Now that you have a local repository, you can send it to Github. The Github Desktop app makes this particularly straightforward.
Find the button that says “Publish repository” (top right of the screen), and click it. You should see this:
Click the “Sign In” button, and either create an account or log in with an existing account. Once you do, click the “Publish Repository” button again, and you’ll see this instead:
Click “Publish Repository”, and Github will automatically send your files to their servers. You can make your repository public if you want, I would recommend leaving it private.
Congratulations! Your vault is now backed up for free on Github.
Step 4: Making changes
Now that your files are encapsulated in a git repository, there is a little more maintenance work you have to do. Every time you make changes to your vault, you’ll have to save those changes by making a commit.
If you make a change to your vault and go back to the Github desktop app, the app will show you exactly the changes you just made. It will look something like this:
If you’re happy with the changes you made, then you can commit to them. You can just click the blue button that says “Commit to main”, or you can enter your own commit message in the box above the button:
Commit messages and descriptions are both optional in Github Desktop, but writing good commit messages can be useful if you ever have to go back and find a particular commit. But it’s totally up to you.
Once you’ve committed, you can again go to the history tab to see the changes you made:
And press the “Push origin” button at the top of the app to sync your changes with Github.
And just like that, your work is now version-controlled and backed up with git and Github. Congratulations! It may not seem like much, but that is a huge deal, and has the potential to change and improve your work forever.
Committing via plugin
If you don’t like manually committing, you can use a plugin to do this for you. Obsidian Git is a community plugin that allows you to automatically create commits and automatically sync to Github. You’ll still have to create the repository locally and on Github, but once you do, this plugin allows you to set it and forget it, which is nice.
Backing up your Obsidian vault on Github has never been easier. You can do it manually, automate it with a plugin, or use an app, all methods we’ve discussed above. It may require learning some new terminology and skills, but if you put in the time and effort, you will reap many rewards.