conql / obsidian-seafile

GNU General Public License v3.0
16 stars 2 forks source link

obsidian-seafile

Introduction

This is an Obsidian plugin designed to synchronize notes across devices using Seafile.

obsidian-seafile-demo

What is Seafile?

Features

Usage

  1. Open settings.
  2. Enter the URL of your server and log into your Seafile account.
  3. Choose the repository you want to sync.
  4. Optional: Specify the files you want to ignore. This uses gitignore syntax. The path to the plugin itself and Obsidian configurations are prepended to the user-defined ignore list.
  5. Click "Enable" to start syncing.
  6. The plugin will now sync your files at intervals.

For each individual file, the syncing status will be displayed next to file names. Additionally, an icon will appear in the bottom right corner of the File Explorer. Clicking on this icon initiates the syncing process immediately, without the need to wait for the next interval.

Notes

  1. Does not support encrypted repositories: This feature has not been implemented yet but will be considered for addition.
  2. Use it at your own risk: This plugin is currently in development. There is a risk of data corruption or loss when using the plugin. Ensure you have backups of your important data.
  3. No large files: Due to limitations of Obsidian's API, downloading or uploading large files (e.g., larger than 50MB) may take a long time or cause the app to crash. Please do not use the plugin for files that are too large.
  4. Clear vault: If you encounter any problems, you could try to Clear vault and restart syncing.
  5. Don't interrupt: Do not close Obsidian while syncing, especially when uploading data to the server (an upload icon will be shown). Otherwise, expect data corruption or loss.
  6. Hidden files: Limited by the API, hideen files and folders (name starting with dot, e.g. ".obsidian") will not be tracked. They are only updated at plugin startup.

    Contribution & Support

Your feedback and suggestions are highly appreciated. If you want to:

Please open a GitHub issue. You can also contact me (@conql) on official Obsidian discord server.