README file from
Githubobsidian-seafile-continued
An Obsidian plugin for synchronizing notes across devices using Seafile, an open-source, self-hosted file sync and share solution.
This is a community continuation of conql/obsidian-seafile with additional features and fixes.
What's different in this fork
- Encrypted repositories are supported (enc_version 2 and 4). Passphrase is prompted on repo selection and on Obsidian restart, never stored in plaintext.
- Manual sync: a "Sync now" button in settings and a "Seafile: Sync now" command (assignable to a hotkey) trigger an immediate sync without waiting for the interval tick.
Features
- Supports both desktop and mobile.
- Uses Seafile's internal syncing API for full synchronization (delta upload/download).
- Fast sync speed, performs well even on low-end Android phones.
- End-to-end encrypted libraries (v2 and v4).
Usage
- Open the plugin settings.
- Enter the URL of your Seafile server and log into your account.
- Choose the repository you want to sync. If it's encrypted, enter the passphrase when prompted.
- Optional: configure an ignore pattern. The syntax loosely follows gitignore. Test it before relying on it. The plugin folder and Obsidian configuration are always ignored.
- Click "Enable" to start syncing.
- The plugin will now sync at the configured interval.
To trigger a sync immediately, click "Sync now" in the settings, or run "Seafile: Sync now" from the command palette (assign it a hotkey if you use it often).
Per-file sync status is shown next to file names in the explorer.
Notes
- Use it at your own risk. This plugin is still under development. There is a risk of data corruption or loss. Keep backups of anything important.
- No large files. Due to limitations of Obsidian's API, downloading or uploading files larger than ~50 MB may take a long time or crash the app. Don't sync large attachments through this plugin.
- Clear vault if you hit issues. The action removes all local files and resyncs from the server.
- Don't interrupt syncing, especially during upload (upload icon shown). Closing Obsidian mid-sync can corrupt data on the server.
- Hidden files (anything starting with a dot, e.g.
.obsidian) are not tracked continuously due to API limits. They are only updated at plugin startup.
Installation
Not yet in the Obsidian community store. Install via BRAT:
- Install BRAT from Settings → Community plugins → Browse.
- BRAT → "Add beta plugin" →
https://github.com/ryanravn/obsidian-seafile-continued. - Enable "Seafile Continued" under Community plugins.
Alternatively, copy main.js, manifest.json, and styles.css from a release into <vault>/.obsidian/plugins/seafile-continued/.
Contribution & Support
Open a GitHub issue for bugs, feature requests, or questions.
Credits
Original plugin by @conql. This continuation maintained by @ryanravn.