R2 Sync

English | 中文

---

English

An Obsidian plugin for multi-device synchronization using Cloudflare R2.

Features

• 📤 Upload Files - Upload local Markdown files to R2 bucket
• 📥 Download Files - Download files from R2 bucket to local
• 🔄 Bidirectional Sync - Automatically detect local and remote differences for two-way sync
• 🗑️ Delete Sync - Track file deletions and sync them across devices
• ⏰ Auto Sync - Support for setting automatic sync intervals
• 💾 Sync on Save - Automatically sync when file is saved
• 📁 Folder Sync - Option to sync specific folders or the entire vault
• 🖼️ Image Sync - Support for syncing image files (png, jpg, gif, webp, svg, etc.)
• 🌐 Multi-language - Support for English and Chinese interface
• 📊 Sync Strategies - Multiple sync strategies to choose from
• ⏳ Sync Progress - Visual feedback during sync operations

Installation

From Community Market (Recommended)

1. Open Obsidian Settings
2. Go to "Community plugins"
3. Search for "R2 Sync"
4. Click Install and Enable

Manual Installation

1. Download the latest version from Releases
2. Extract to .obsidian/plugins/r2-sync/ directory
3. Enable the plugin in Obsidian Settings

Configuration

1. Get Cloudflare R2 Credentials

1. Log in to Cloudflare Dashboard
2. Go to R2 Object Storage
3. Create a bucket or use an existing one
4. Create an API token in "Manage R2 API Tokens"
5. Note the following information:
   • Access Key ID
   • Secret Access Key
   • Bucket Name
   • API Endpoint (format: https://<account_id>.r2.cloudflarestorage.com)

2. Configure Plugin

1. Open Obsidian Settings → R2 Sync Settings
2. Fill in the following:
   • Language: Interface language (English/Chinese)
   • Bucket Name: R2 bucket name
   • API Endpoint: https://<account_id>.r2.cloudflarestorage.com
   • Access Key ID: API access key ID
   • Secret Access Key: API secret access key
   • Sync Folder (optional): Leave empty to sync entire vault
   • Auto Sync: Enable/disable automatic sync
   • Sync Interval: Auto sync interval (minutes)
   • Sync on Save: Automatically sync when file is saved
   • Sync Strategy: Choose sync behavior (see below)
   • Sync Images: Also sync image files

Sync Strategies

Strategy	Description
Bidirectional	Sync both ways, track deletions (default)
Upload only	Only upload local files to R2
Download only	Only download R2 files to local
Local first	Local files take priority on conflict
Remote first	Remote files take priority on conflict

Usage

Test Connection

Click "Test Connection" button to verify configuration.

Manual Sync

• Upload All Files: Upload all local files to R2
• Download All Files: Download all files from R2 to local
• Bidirectional Sync: Smart sync, only upload/download files with differences

Command Palette

Use Ctrl+P to open command palette, available commands:

• Upload all files to R2
• Download all files from R2
• Bidirectional sync

Ribbon Icon

Click the cloud icon in the left ribbon for quick bidirectional sync.

Supported File Types

• Markdown files (.md)
• Image files (.png, .jpg, .jpeg, .gif, .webp, .svg, .bmp, .ico) - requires "Sync Images" option

Notes

1. Backup your notes before first use
2. File deletions are tracked and synced across devices
3. Keep your API keys secure and do not share them
4. Image sync needs to be enabled in settings

License

MIT License

---

中文

通过 Cloudflare R2 实现 Obsidian 多端同步的插件。

功能特性

• 📤 上传文件 - 将本地 Markdown 文件上传到 R2 存储桶
• 📥 下载文件 - 从 R2 存储桶下载文件到本地
• 🔄 双向同步 - 自动检测本地和远程差异，进行双向同步
• 🗑️ 删除同步 - 跟踪文件删除并在设备间同步删除操作
• ⏰ 自动同步 - 支持设置自动同步间隔
• 💾 保存时同步 - 文件保存时自动同步
• 📁 文件夹同步 - 可选择同步特定文件夹或整个仓库
• 🖼️ 图片同步 - 支持同步图片文件（png、jpg、gif、webp、svg 等）
• 🌐 多语言 - 支持中英文界面
• 📊 同步策略 - 多种同步策略可选
• ⏳ 同步进度 - 同步过程中显示进度提示

安装

从社区市场安装（推荐）

1. 打开 Obsidian 设置
2. 进入「社区插件」
3. 搜索「R2 Sync」
4. 点击安装并启用

手动安装

1. 从 Releases 下载最新版本
2. 解压到 .obsidian/plugins/r2-sync/ 目录
3. 在 Obsidian 设置中启用插件

配置

1. 获取 Cloudflare R2 凭证

1. 登录 Cloudflare Dashboard
2. 进入 R2 对象存储
3. 创建存储桶或使用现有存储桶
4. 在「管理 R2 API 令牌」中创建 API 令牌
5. 记录以下信息：
   • Access Key ID
   • Secret Access Key
   • 存储桶名称
   • API 端点（格式：https://<account_id>.r2.cloudflarestorage.com）

2. 配置插件

1. 打开 Obsidian 设置 → R2 同步设置
2. 填写以下信息：
   • 语言：界面语言（英文/中文）
   • 存储桶名称：R2 存储桶名称
   • API 端点：https://<account_id>.r2.cloudflarestorage.com
   • Access Key ID：API 访问密钥 ID
   • Secret Access Key：API 访问密钥
   • 同步文件夹（可选）：留空则同步整个仓库
   • 自动同步：是否启用自动同步
   • 同步间隔：自动同步间隔（分钟）
   • 保存时同步：文件保存时自动同步
   • 同步策略：选择同步行为（见下文）
   • 同步图片：同时同步图片文件

同步策略

策略	说明
双向同步	双向同步，跟踪删除操作（默认）
仅上传	仅上传本地文件到 R2
仅下载	仅下载 R2 文件到本地
本地优先	冲突时本地文件优先
远程优先	冲突时远程文件优先

使用方法

测试连接

点击「测试连接」按钮验证配置是否正确。

手动同步

• 上传所有文件：将本地所有文件上传到 R2
• 下载所有文件：从 R2 下载所有文件到本地
• 双向同步：智能同步，只上传/下载有差异的文件

命令面板

使用 Ctrl+P 打开命令面板，可使用以下命令：

• 上传所有文件到 R2
• 从 R2 下载所有文件
• 双向同步

功能区图标

点击左侧功能区云图标可快速执行双向同步。

支持的文件类型

• Markdown 文件（.md）
• 图片文件（.png、.jpg、.jpeg、.gif、.webp、.svg、.bmp、.ico）- 需开启「同步图片」选项

注意事项

1. 首次使用建议先备份笔记
2. 文件删除会被跟踪并在设备间同步
3. 请妥善保管 API 密钥，不要泄露
4. 图片同步需要在设置中启用

许可证

MIT License

---

Changelog

v1.1.0

New Features

• Delete Sync: Track file deletions and sync them across devices
• Sync on Save: Automatically sync when file is saved
• Sync Images: Support for syncing image files (png, jpg, gif, webp, svg, bmp, ico)
• Sync Strategies: Added 5 sync strategies (Bidirectional, Upload only, Download only, Local first, Remote first)
• Sync Progress: Visual feedback during sync operations
• Language Setting: Added language setting to switch between English and Chinese

Improvements

• Improved error handling and error messages
• Better UI with sentence case
• Code quality improvements with ESLint

v1.0.0

• Initial release
• Basic upload, download, and bidirectional sync
• Auto sync with configurable interval
• Folder sync support
• Connection test