haierkeys/obsidian-image-api-gateway

Obsidian Image API Gateway

镜像概述

本镜像为Obsidian插件https://github.com/haierkeys/obsidian-custom-image-auto-uploader%E6%8F%90%E4%BE%9B%E5%9B%BE%E7%89%87%E4%B8%8A%E4%BC%A0%E3%80%81%E5%AD%98%E5%82%A8%E5%8F%8A%E4%BA%91%E5%90%8C%E6%AD%A5%E6%9C%8D%E5%8A%A1%EF%BC%8C%E6%94%AF%E6%8C%81%E6%9C%AC%E5%9C%B0%E5%AD%98%E5%82%A8%E3%80%81%E9%98%BF%E9%87%8C%E4%BA%91OSS%E3%80%81Cloudflare R2、Amazon S3、MinIO等多种存储方式，可部署在家庭NAS或远程服务器上。

核心功能

• ✅ 支持图片上传与基础处理（裁剪、缩放）
• ✅ 令牌授权机制增强API安全性
• ✅ 多存储方式支持：本地、阿里云OSS、Cloudflare R2、Amazon S3、MinIO
• ✅ 本地与云存储双保存，便于数据迁移
• ✅ Docker部署支持，适配家庭NAS及远程服务器
• ✅ 多用户公共服务模式（含WebGUI管理界面）

使用场景

1. 个人Obsidian笔记图片自动上传与云端同步
2. 家庭NAS上的图片本地存储与远程访问
3. 小型团队共享笔记的图片统一管理
4. 个人项目的轻量级图片存储解决方案

配置说明

目录准备

bash
# 创建项目目录结构
mkdir -p /data/image-api/{config,storage/logs,storage/uploads}
cd /data/image-api

首次启动会自动生成默认配置config/config.yaml，也可手动下载：

bash
wget -P ./config/ https://raw.githubusercontent.com/haierkeys/obsidian-image-api-gateway/main/config/config.yaml

Docker部署示例

拉取镜像

bash
docker pull haierkeys/obsidian-image-api-gateway:latest

启动容器

bash
docker run -tid --name image-api \
        -p 9000:9000 -p 9001:9001 \
        -v /data/image-api/storage/:/api/storage/ \
        -v /data/image-api/config/:/api/config/ \
        haierkeys/obsidian-image-api-gateway:latest

单服务模式配置

1. 修改config.yaml中的http-port（服务端口）和auth-token（访问令牌）
2. 启动容器后，API地址为http://{IP:PORT}/api/upload，使用auth-token验证访问

多用户模式配置

1. 修改config.yaml中的database（数据库配置）、user.is-enable（开启多用户）、user.register-is-enable（允许注册）
2. 访问http://{IP:PORT}进入WebGUI完成用户注册与配置
3. 多用户API地址为http://{IP:PORT}/api/user/upload，通过WebGUI获取个人配置

配置文件详情

默认配置文件为config.yaml，更多参数说明参考：https://github.com/haierkeys/obsidian-image-api-gateway/config/config.yaml

其他资源

• https://github.com/haierkeys/obsidian-auto-image-remote-uploader
• https://github.com/haierkeys/obsidian-image-api-gateway/releases