Obsidian Stats logoObsidian Stats

Unchanged Attachments to OSS

by aohan
5
4
3
2
1
Score: 50/100
Install Code

Description

【Obsidian插件】将常用不可变附件上传到阿里云oss，方便同步和共享

Reviews

No reviews yet.

Stats

0
stars
15
downloads
0
forks
4
days
4
days
4
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
33
commits

Latest Version

0.1.3
5 days ago

Changelog

See all version on GitHub

README file from

Github

Unchanged Attachments to OSS

An Obsidian plugin that automatically uploads attachments (images, videos, audio, PDFs) to Aliyun OSS, stores them as permanent oss:// references, and renders them with dynamically signed URLs. Solves multi-device sync and sharing challenges for large media files.

Features

  • Auto Upload: Paste or drag attachments to automatically upload to OSS
  • V4 Dynamic Signing: Secure access to private buckets with auto-cached, auto-renewed signed URLs
  • Encrypted Credential Sync: AK/SK encrypted with master password-derived key (AES-GCM), syncs with Vault without exposing secrets
  • Cross-Platform: Works on PC (Windows/macOS) and mobile (iOS/Android)
  • Resumable Uploads: Network interruptions preserve staging and multipart state for recovery
  • Explicit Deletion: Right-click menu and file menu provide linked deletion; native delete won't touch OSS
  • Migration Tool: Migrate local attachments to OSS in bulk or by folder
  • Status Bar: Shows upload status and progress, click to toggle auto-upload

Supported formats: images (png/jpg/jpeg/gif/webp/avif/svg/bmp), videos (mp4/mov/webm/mkv/ogv/m4v), audio (mp3/wav/m4a/ogg/flac/aac/opus), and PDF. Markdown, Canvas, and Base files stay in Vault.

Installation

From Community Plugins

  1. Open Obsidian Settings → Community Plugins
  2. Search for "Unchanged Attachments to OSS"
  3. Install and enable

Manual Installation

  1. Download main.js, manifest.json, and styles.css from the latest release
  2. Create a folder unchanged-attachments-to-oss in your vault's .obsidian/plugins/ directory
  3. Place the three files in that folder
  4. Restart Obsidian and enable the plugin in Settings → Community Plugins

Configuration

Field Required Description
region Yes V4 signing region, e.g., cn-hangzhou
bucketName Yes OSS bucket name
accessKeyId Yes Aliyun Access Key ID
accessKeySecret Yes Aliyun Access Key Secret
endpoint No OSS endpoint hostname (auto-derived from region)
objectKeyPrefix Yes Prefix for all object keys
signedUrlExpireSeconds No Signed URL validity (61–604800s, default 3600)
autoUpload No Toggle auto-upload (default: enabled)

On first save, you'll set a master password (min 10 chars). The plugin uses PBKDF2-SHA256 to derive an AES-256 key and encrypts AK/SK with AES-GCM. Only ciphertext is stored in Vault.

Usage

  • Paste: Ctrl+V to paste and auto-upload
  • Drag & Drop: Drop files into editor to upload
  • Preview: Reading View and Live Preview render signed URLs automatically
  • Delete: Right-click attachments or use file menu for linked deletion

Technical Notes

  • Uses only Obsidian requestUrl for HTTP (mobile compatible)
  • Uses only Web Crypto for OSS Signature V4 (no Node.js dependencies)
  • Multipart upload with 4MB chunks for resumability
  • Signed URL caching (LRU) for performance

License

MIT

中文说明

【Obsidian 插件】将常用不可变附件（图片/视频/音频/PDF）自动上传到阿里云 OSS，以永久 oss:// 引用保存，并在渲染时动态生成临时签名 URL，解决多端同步和共享问题。

功能特性

  • 自动上传：粘贴、拖入附件自动上传到 OSS，无需手动操作
  • V4 动态签名：私有 Bucket 安全访问，签名 URL 自动缓存并在使用前续期
  • 加密凭证同步：AK/SK 经主密码派生密钥和 AES-GCM 加密后随 Vault 同步，主密码不落盘
  • 多端兼容：PC（Windows/macOS）+ 移动端（iOS/Android）均可使用
  • 断点续传：网络、超时和 OSS 5xx 中断会保留本地 staging 与分片状态，可从任务入口恢复
  • 显式删除：附件右键菜单和文档文件菜单提供联动删除，原生删除不会静默操作 OSS
  • 迁移工具：支持一键迁移全部或指定文件夹的本地附件到 OSS
  • 状态栏指示：显示自动上传状态和上传进度，支持点击开关

支持的附件格式：图片（png/jpg/jpeg/gif/webp/avif/svg/bmp）、视频（mp4/mov/webm/mkv/ogv/m4v）、音频（mp3/wav/m4a/ogg/flac/aac/opus）和 PDF。Markdown、Canvas 与 Base 保留在 Vault 中，不上传 OSS。

使用范围限制

当前版本只使用 OSS 标准公网 Endpoint。根据阿里云官方策略变更公告，2025 年 3 月 20 日后新开通 OSS 服务的用户，通过默认公网域名访问中国内地 Bucket 的上传、下载、删除、HEAD、ListObjects 和 Multipart 等数据 API 会被阻断，并返回 400 PublicEndpointForbidden。

这类用户请在首次配置时选择非中国内地 Region。2025 年 3 月 20 日前已开通 OSS 服务的用户不受该策略影响。已有 oss:// 引用的 Vault 不要直接切换 Region/Bucket；它们属于不可变存储身份，只能通过专用迁移流程变更。

安装

手动安装

  1. 克隆或下载本项目
  2. 安装依赖并构建：
npm install
npm run build
  1. 将以下文件复制到你的 Obsidian vault 插件目录：
<vault>/.obsidian/plugins/unchanged-attachments-to-oss/
├── main.js
├── manifest.json
└── styles.css（如有）
  1. 重启 Obsidian，进入 设置 → 第三方插件，关闭安全模式（如需要），启用 Unchanged Attachments to OSS

开发模式

npm run dev   # 监听模式，修改后自动重新构建

构建完成后手动复制 main.js 到 vault 插件目录，在 Obsidian 中重新加载插件即可。

配置

打开插件设置页，填写以下字段：

字段 必填 说明
region 是 V4 签名地域，如 cn-hangzhou；旧格式 oss-cn-hangzhou 会自动归一化
bucketName 是 Bucket 名称
accessKeyId 是 Access Key ID
accessKeySecret 是 Access Key Secret
endpoint 否 OSS Endpoint hostname，默认 oss-{region}.aliyuncs.com
objectKeyPrefix 是 对象 Key 前缀，默认使用 vault 名称且禁止为空或以 / 开头；不能含 . / .. 路径段或占用插件内部命名
signedUrlExpireSeconds 否 V4 签名 URL 有效期（61–604800 秒），默认 3600
autoUpload 否 自动上传开关，默认开启

保存时会通过标准 OSS Endpoint 和 Signature V4 访问每次随机的不存在探针 Key，以 404 NoSuchKey 验证 Bucket、凭证和 oss:GetObject 权限。探针不会列举 Bucket、创建对象或下载真实内容。校验失败会阻止保存，并区分提示凭证、权限、Bucket/Region、请求参数或网络问题。

首次保存还需设置至少 10 个字符的主密码。插件使用 Web Crypto PBKDF2-SHA256 派生不可导出的 AES-256 密钥，并以 AES-GCM 加密 AK/SK；Vault 中只同步密文、随机 salt/IV 和算法参数。插件每次加载或热重载后保持锁定，需要在设置页输入主密码解锁。主密码忘记后无法恢复原凭证，只能重新填写 AK/SK 并生成新密文。

Bucket、Region、Endpoint 与 Object Key 前缀共同组成存储身份；前缀中的空格也是 Object Key 的真实内容，不会被插件静默裁剪。首次配置后可轮换 AK/SK 或调整签名有效期；当前版本会阻止直接切换存储身份，因为历史 oss:// 引用不携带 Bucket，静默切换会让旧附件全部失效。

使用方法

日常使用

  • 粘贴附件：在编辑器中 Ctrl+V 粘贴图片/PDF/音视频，自动上传并插入 ![](https://raw.githubusercontent.com/xudaren/unchanged-attachments-to-oss/HEAD/oss:///{percentEncodedKey})
  • 拖入附件：直接拖拽文件到编辑器，同样自动上传
  • 渲染预览：Reading View 和 Live Preview 均自动将 oss:// 链接替换为签名 URL 显示
  • 删除联动：在 OSS 附件右键菜单中移除单条引用，或从文件菜单执行“删除文档并处理 OSS 附件”
  • 状态栏：点击状态栏图标可快速开关自动上传

关闭自动上传后不会接管新的粘贴、拖入或落盘附件；正在进行的自动任务会在下一次 OSS 请求前暂停并保留 staging/分片进度，可稍后手动重试。

PDF 说明

Obsidian 原生 PDF 批注功能依赖本地文件，上传到 OSS 后无法使用原生批注。

推荐工作流：

  1. PDF 放本地，先用 Obsidian 原生批注功能完成标注
  2. 批注内容会保存到 companion .pdf.md 文件
  3. 命令面板执行 迁移所有本地附件到 OSS
  4. 之后 PDF 显示为轻量附件卡片，点击“浏览器打开”，笔记继续在 companion md 里维护

如果需要继续使用 Obsidian 原生 PDF 批注，请暂停自动上传，并避免执行包含该 PDF 的迁移命令。

数据安全

  • 已落地附件只有在所有真实引用完成替换并回读验证后才会删除；找不到引用或任一文档失败时保留本地文件。
  • 粘贴/拖入由插件接管后会先在 .oss-plugin-staging/ 建立内部恢复文件；应用中断后可继续上传或提交已经完成的 Object，任务完成后自动清理 staging。
  • 引用依据 Obsidian 的链接解析结果识别，不会仅凭同名文件进行全库替换。
  • oss:// 中的 Object Key 使用统一 URI 编码，Vault 名含空格、括号或中文时也可可靠渲染、删除和核验。
  • 迁移会跳过没有真实引用的附件，执行前展示数量并要求确认。
  • 混合粘贴或拖入包含不支持文件时由 Obsidian 默认处理；随附件附带的文本/HTML 替代表达不会阻止直传。
  • 编辑器直传立即生效；附件落盘兜底只在布局就绪后监听，并只扫描 MetadataCache 命中的候选文档，不处理冷启动历史附件。

命令面板

Ctrl/Cmd+P 打开命令面板，可用命令：

命令 说明
测试 OSS 连接 手动验证凭证有效性
重试未完成上传 桌面端和移动端均可恢复待处理任务
清理孤儿分片上传 重置本机日志中超过 24 小时的分片任务；未知远端任务只报告、不自动中止
核验 OSS 对象引用 对比 OSS 对象与 Vault 中 Markdown/Canvas/Base 引用
迁移所有本地附件到 OSS 全量迁移 vault 中的本地附件
迁移指定文件夹附件到 OSS 选择性迁移指定文件夹的附件

插件不维护 OSS 引用索引，启动时不会扫描整个 Vault，也不会自动请求 OSS 执行维护。单个 OSS 附件通过附件右键菜单删除；整篇 Markdown 通过文件右键菜单“删除文档并处理 OSS 附件”删除。使用 Obsidian 原生删除时只删除本地文档，不联动 OSS，遗留对象可通过“核验 OSS 对象引用”处理。

技术约束

  • 仅使用 Obsidian requestUrl 收发 HTTP，兼容移动端
  • 仅使用 Web Crypto (crypto.subtle) 实现 OSS Signature V4，不依赖 Node.js API
  • 统一走 OSS Multipart Upload，支持断点续传
  • 分片大小固定 4MB，平衡移动端内存与请求数
  • 签名 URL 内存缓存（LRU），减少滚动时重复签名开销

License

MIT

Sponsors