obsidian-seafile - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #typescript #golang #android #nodejs #java #cli #pytorch #security #mcp #openai

obsidian-seafile

(★ 58)

No description available.

File Explorer

Download Latest Version (.zip)

- - release.yml
- obsidian.ts
- deflate.py
- generate_test_files.py
- - global.d.ts
  - obsidian.d.ts
- - controller.ts
  - node.ts
- - env.ts.example
  - server.test.ts
  - sync_controller.test.ts
- - dialog_modal.ts
  - explorer.module.css
  - explorer.ts
  - icons.ts
  - login_modal.ts
  - repo_modal.ts
  - seafile_logo.svg
  - setting_tab.ts
- config.ts
- main.ts
- server.ts
- settings.ts
- utils.ts
.editorconfig
.eslintignore
.eslintrc.json
.gitignore
.gitmodules
.npmrc
esbuild.config.mjs
jest.config.js
LICENSE.txt
manifest.json
package-lock.json
package.json
pnpm-lock.yaml
README.md
tsconfig.json
versions.json

# Installation Guide

1. Get the code

git clone https://github.com/conql/obsidian-seafile

Downloads the entire project code from GitHub to your computer.

cd obsidian-seafile

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# obsidian-seafile

## Introduction

This is an [Obsidian](https://obsidian.md/) plugin designed to synchronize notes across devices using Seafile.

![obsidian-seafile-demo](https://github.com/conql/obsidian-seafile/assets/49243542/5b8ac9aa-4180-4ca4-9abe-0b94134fd0c1)

### What is Seafile?
- [Seafile](https://www.seafile.com/) is an open source, self-hosted file sync and share solution with high performance and reliability. It supports efficient synchronization through delta downloads and uploads. Also, it provides user-friendly web UI and excellent syncing clients across multiple operating systems.

### Features
- Supports both desktop and mobile.
- Utilizes Seafile's internal syncing API for full synchronization functionality.
- Fast sync speed, performs well even on low-end Android phones.

## Usage
<img src="https://github.com/conql/obsidian-seafile/assets/49243542/26399e88-d054-41cf-ae19-7bc82b178522" width="300">

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. The pattern format loosely follows [gitignore syntax](https://git-scm.com/docs/gitignore). Test your pattern before using it. 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:
- Report bugs or issues
- Submit feature requests or enhancements

Please open a [GitHub issue](https://github.com/conql/obsidian-seafile/issues). You can also contact me (@conql) on official Obsidian discord server.