Skip to main content

Command Palette

Search for a command to run...

Connecting GitHub with Obsidian

Updated
β€’5 min read
Connecting GitHub with Obsidian
A
Information Systems student focused on Defensive Security, with hands-on experience in SOC operations, network security, and IT fundamentals, seeking an entry-level role in SOC, Network Engineering, IT or Network security.

Now I’ll explain how to connect Obsidian to GitHub step by step, so that all your notes in Obsidian are automatically saved to GitHub as a backup, so you can access or share them at any time.

πŸ› οΈ Prerequisites:
βœ… A GitHub account

βœ… A Git installation on your device

βœ… An Obsidian folder (the Vault) is ready

βœ…I will use the simplest method, which is GitHub Desktop.

🧭 Steps in detail:

1️⃣ Create a Repository on GitHub :

  • Log in to GitHub Or GitHub Desktop :

Click the New button to create a new Repo

Click the New button to create a new Repo

Name it, for example: My-Study-Archive

Name it, for example: My-Study-Archive

  • Make it Public or Private as you wish

  • Important: Do add README or any other files

On Your Pc

On Your Pc

2️⃣ Prepare the Obsidian folder :

  • Open Obsidian :

Create a New Valut :

Create a New Valut :

You will give the file a name and choose a location .

You will give the file a name and choose a location .

This is the final form with different names and storage location.

This is the final form with different names and storage location.

This is our final form you can add files and folders and do everything and I will simultaneously recite inside GitHub

This is our final form you can add files and folders and do everything and I will simultaneously recite inside GitHub

Here we are testing. We have created folders and files. We will now upload them and take a backup copy on GitUp using the following methods:

First, when you open GitHub Desktop it, you will find the following:

In order for the places to be connected, we will make a comment now. Everything we have done is available to you on the machine. We must always take a backup copy. Do not forget this by doing the following:

Comment on the data

Comment on the data

Save the commit
Whenever you make a change:

Go to GitHub Desktop

You’ll find some time

Write a simple description (e.g., updating the networking lecture)

Click the commit to the main page β†’ then push the original

Now to make sure, open GitHub on the browser and you will find the following:

This is my friend, the simplest way to save everything you have learned and through which you can search and browse. Thus, you must now learn Obsidian manually with yourself and through experience. Also, below I will add some additions that you can do to improve the process, but if you are a beginner in this matter and do not want to do this, then do not do it. We agree.

Some helpful plugins:

πŸŽ‰ Congratulations!
All your notes are now:

Organized within Obsidian

Saved on GitHub

Available from anywhere

And easily shared with any colleague or study community



⚠️ A simple warning

Personally, I don’t like using full automatic sync without review.**

Imagine if you accidentally deleted something important?
And the sync happened automatically?
Then the problem would have been logged and uploaded without you even noticing!

Yes, Git allows you to restore files…
But why take the risk?

βœ… Review your changes before uploading them
βœ… And if you like automation, use the Obsidian Git plugin intelligently.

πŸ”„ Plugin (Optional): Obsidian Git for automatic sync
If you want Obsidian to automatically sync (commit + push), use this plugin:

πŸͺ›

Installation steps:
Open Obsidian

Settings β†’ Thired-Party plugin β†’ Community Plugins

Disable Safe Mode

Click Browse

Find Obsidian Git β†’ Click Install β†’ Enable

βš™οΈ Suggested Settings:

preparationvalueDescription
Auto Pull on Bootβœ… EnabledWhen the application runs, it automatically pulls the latest updates from the remote repository.
Auto Commitβœ… EnabledChanges are automatically saved (committed) to Git without manual intervention.
Auto Pushβœ… EnabledAfter commit, changes are automatically pushed to the remote repository (push).
Auto Commit MessageAuto update from ObsidianThe default message used in every auto-commit.
Update Duration (ms)300000 (every 5 minutes)Automatic operations (commit + push) are executed every 300,000 milliseconds (5 minutes).

βœ… Result:
Every time you open Obsidian or edit a file:

The edit will be automatically logged

It will be uploaded to GitHub without any manual commands

πŸŽ‰ Congratulations!
You now have:

🧠 An organized note system within Obsidian

☁️ A backup on GitHub

🌍 Accessible from anywhere

πŸ”„ And easy sharing of notes with your colleagues or the community

πŸ’¬ "Control the code, and you control the world." πŸ” From wiping metadata to gaining root access β€” every step is documented and my goal is to deeply understand the system, not just hack!

Abdelwahab Shandy

Linkedin

GitHub

See You Soon

AS Cyber β€œ)).