Skip to content

Latest commit

 

History

27 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

图床转站助手 (PicBed Switcher)

一款支持多主流图床的 Markdown 文档图床地址批量转换工具平台。

目录

一、项目介绍

1.1 项目简介

图床转站助手是一款专为解决Markdown文档中图床地址批量转换需求而开发的工具平台。支持GitHub、Gitee、腾讯云COS、阿里云OSS、七牛云、百度云 BOS、华为云 OBS、又拍云、MinIO、EasyImage等多种图床的适配与切换,提供简洁易用的操作界面,保障用户数据安全。

1.2 项目预览

项目登录页
login
项目首页
home

1.3 核心功能

  • 用户认证:支持用户注册、登录、邮箱验证、密码找回和基于 JWT 的会话管理
  • 图床配置管理:支持添加、编辑、删除、测试、查看多种图床配置,敏感信息加密存储
  • Markdown文档处理:自动识别文档中的图床地址,支持批量转换
  • 转换任务队列:支持持久化转换任务,Redis 开启后由后台 worker 消费队列,刷新页面后可继续查看任务进度
  • 图床地址转换:支持多种主流图床之间的相互转换
  • 本地图片上传:支持识别 Markdown 中的本地图片路径,上传到目标图床后自动替换为远程地址
  • 转换历史记录:记录用户的文档转换历史,支持查看替换明细、错误摘要和转换结果
  • 文档下载:转换完成后自动生成新文档,支持一键下载

1.4 支持的图床

  • GitHub:基于GitHub仓库的图床服务
  • Gitee:基于Gitee仓库的图床服务
  • 腾讯云COS:腾讯云对象存储服务
  • 阿里云OSS:阿里云对象存储服务
  • 七牛云:七牛云对象存储服务
  • 百度云 BOS:百度智能云对象存储服务
  • 华为云 OBS:华为云对象存储服务
  • 又拍云:又拍云云存储服务
  • MinIO:自建 S3 兼容对象存储服务
  • EasyImage:自建 EasyImage 图床服务
  • 其他图床:兼容通用上传接口的图床服务

1.5 技术栈

1.5.1 后端

  • 语言:Go 1.25+
  • 框架:Gin
  • 数据库:PostgreSQL 16+
  • 队列:Redis 5.0+(可选,未开启时回退为本进程内存队列)
  • ORM:GORM
  • 认证:JWT
  • 加密:AES-256-GCM

1.5.2 前端

  • 框架:Vue 3
  • 构建工具:Vite
  • 语言:TypeScript
  • UI组件库:Element Plus
  • 状态管理:Pinia
  • 路由:Vue Router

1.6 项目结构

picbed-switcher/
├── backend/                  # Go 后端服务
│   ├── cmd/                  # 应用入口
│   ├── internal/             # 后端内部模块
│   │   ├── config/           # 环境配置加载
│   │   ├── database/         # 数据库连接与初始化
│   │   ├── handler/          # HTTP 路由与处理器
│   │   ├── middleware/       # 鉴权、CORS、限流等中间件
│   │   ├── model/            # GORM 数据模型
│   │   ├── picbed/           # 图床上传适配器
│   │   └── utils/            # 加密、JWT、Markdown 处理工具
│   ├── migrations/           # PostgreSQL 数据库迁移
│   ├── go.mod
│   ├── go.sum
│   └── .env.example
├── frontend/                 # Vue 3 前端应用
│   ├── public/               # 静态资源
│   ├── src/
│   │   ├── components/       # 页面组件与对话框组件
│   │   ├── composables/      # 业务状态、请求和表单逻辑
│   │   │   └── workspace/    # 工作台内图床配置、转换、本地上传等业务逻辑
│   │   ├── App.vue           # 应用根组件
│   │   ├── main.ts           # 前端入口
│   │   └── style.css         # 全局样式
│   ├── package.json
│   ├── package-lock.json
│   ├── vite.config.ts
│   └── .env.example
├── deploy/                   # Docker 构建与部署配置
│   ├── Dockerfile
│   ├── docker-compose.yml
│   ├── nginx.conf
│   ├── supervisord.conf
│   ├── entrypoint.sh
│   └── .env.example
├── .github/                  # 项目图片等 GitHub 资源
├── .dockerignore
├── .gitignore
├── LICENSE
└── README.md

二、本地开发快速启动

2.1 环境要求

  • Go 1.25+
  • Node.js 20+
  • PostgreSQL 16+

如果本地没有安装部署 PostgreSQL,可参考以下docker快速部署相关数据库(可选)。

创建 pgsql 指令:

docker run -d --name pg-prod \
  -p 5432:5432 \
  -v /data/PgSqlData:/var/lib/postgresql/data \
  -e POSTGRES_PASSWORD="123456ok!" \
  -e LANG=C.UTF-8 \
  -e TZ=Asia/Shanghai \
  postgres:17-alpine

查看是否创建成功:

[root@docker-server ~]# docker ps
CONTAINER ID   IMAGE                COMMAND                  CREATED          STATUS          PORTS                                         NAMES
22205f8e78c6   postgres:17-alpine   "docker-entrypoint.s…"   34 minutes ago   Up 34 minutes   0.0.0.0:5432->5432/tcp, [::]:5432->5432/tcp   pg-prod

2.2 克隆项目

git clone https://github.com/zyx3721/picbed-switcher.git
cd picbed-switcher

2.3 数据库配置

2.3.1 本地数据库创建

创建 PostgreSQL 数据库:

psql -Upostgres -c "CREATE DATABASE picbed;"

2.3.2 容器数据库创建

进入容器内的 psql 交互界面:

docker exec -it pg-prod psql -U postgres

在 psql 中创建 picbed 库(执行后输入 \q 退出):

CREATE DATABASE picbed;

应用会在首次启动时自动执行 backend\migrations\001_init_schema.sql 初始化数据库,包括创建表结构和初始数据。

2.4 后端配置与启动

如果没有配置go的镜像代理,可以参考 Go 国内加速:Go 国内加速镜像 | Go 技术论坛

  1. 进入后端目录下载相关依赖:
cd backend
go mod download
  1. 配置数据库连接等信息:
# 步骤1:复制模板文件
cp env.example .env

# 步骤2:编辑 .env,配置数据库连接等信息
vim .env
# 服务器配置
SERVER_HOST=localhost
SERVER_PORT=8080
GIN_MODE=release

# 数据库配置
DB_HOST=postgres
DB_PORT=5432
DB_NAME=picbed
DB_USER=postgres
DB_PASSWORD=your_database_password
DB_SSLMODE=disable

# JWT 配置
JWT_SECRET=your_jwt_secret_key
JWT_EXPIRE_HOURS=24

# 密码找回配置
APP_BASE_URL=http://localhost:5173
PASSWORD_RESET_TOKEN_TTL_MINUTES=5
EMAIL_VERIFICATION_TOKEN_TTL_MINUTES=5

# SMTP 邮件配置(用于发送密码重置邮件)
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_SECURITY=auto
SMTP_USERNAME=noreply@example.com
SMTP_PASSWORD=your_smtp_password
SMTP_FROM=noreply@example.com
SMTP_FROM_NAME=PicBed Switcher

# Redis 转换任务队列配置(开启后替代单进程内存队列)
REDIS_ENABLED=false
REDIS_ADDR=localhost:6379
REDIS_PASSWORD=
REDIS_DB=0
REDIS_CONVERT_QUEUE=picbed:convert_tasks
CONVERT_WORKER_CONCURRENCY=1

部分配置说明

  • SMTP_SECURITY 可选值为 autosslstarttlsnone

    • 465 端口通常使用 ssl
    • 587 端口通常使用 starttls
    • 保留 auto 时,465 自动使用隐式 TLS,其他端口会在服务端支持时启用 STARTTLS
  • REDIS_ENABLED=true 时,转换任务会写入 Redis 队列并由后台 worker 消费

  • REDIS_ENABLED=false 时,会回退为本进程内存队列,适合不启 Redis 的本地开发

  • REDIS_CONVERT_QUEUE 指定 Redis List 队列名称,默认 picbed:convert_tasks;多个环境共用同一个 Redis 时建议使用不同队列名区分

  • CONVERT_WORKER_CONCURRENCY 控制同时处理的转换任务数量,默认 1 表示串行处理

  1. 运行后端服务:
# 方式1:前台运行(终端关闭则服务停止)
go run cmd/main.go

# 方式2:后台运行(日志输出到 app.log)
nohup go run cmd/main.go > app.log 2>&1 &

后端服务默认运行在 http://localhost:8080 ,如需指定地址和端口,请修改环境变量文件内的 SERVER_HOSTSERVER_PORT 参数。首次启动会自动创建数据库和默认管理员账户 admin / 123456

2.5 前端配置与启动

  1. 进入前端目录下载相关依赖:
cd frontend
npm install
  1. 配置 API 地址(可选):
# 配置说明:
# - 后端端口 = 8080:无需创建 .env 文件(默认值为 http://localhost:8080)
# - 后端端口 ≠ 8080:需要创建 .env 文件(指定正确端口,例如后端端口改为 8090)
#   创建 .env 文件,例如:
echo "VITE_API_BASE_URL=http://localhost:8080" > .env
  1. 启动前端服务:
# 方式1:前台运行(终端关闭则服务停止)
npm run dev
# 如果要指定外部访问和监听端口,可执行例如:
npm run dev -- --host --port 5173

# 方式2:后台运行(日志输出到 picbed-frontend.log)
nohup npm run dev > picbed-frontend.log 2>&1 &

前端服务默认运行在 http://localhost:5173/

2.6 访问系统

  • 首页http://localhost:5173

    • 默认用户名admin
    • 默认邮箱admin@example.com
    • 默认密码123456
  • API 文档http://localhost:8080/swagger/index.html

三、Docker Compose 快速部署(推荐)

3.1 部署目录结构

所有相关文件统一放在 deploy/ 目录下,单镜像包含前端(Nginx)、后端(backend),通过 supervisord 管理多进程。

deploy/
├── docker-compose.yml    # 服务编排配置
├── .env                  # 环境变量(需自行创建,见 3.2)
├── .env.example          # 环境变量模板
├── PicBedData/           # 应用持久化数据(首次启动自动创建)
│   └── logs/             # 运行日志
└── PgSqlData/            # PostgreSQL 数据(首次启动自动创建)

3.2 准备配置文件

进入 deploy 目录,创建 .env 环境变量文件:

cd deploy
vim .env

.env 文件内容参考:

GIN_MODE=release

# 数据库配置
DB_HOST=postgres
DB_PORT=5432
DB_NAME=picbed
DB_USER=postgres
DB_PASSWORD=your_database_password
DB_SSLMODE=disable

# JWT 配置
JWT_SECRET=your_jwt_secret_key
JWT_EXPIRE_HOURS=24

# 密码找回配置
APP_BASE_URL=http://your-domain.com
PASSWORD_RESET_TOKEN_TTL_MINUTES=5
EMAIL_VERIFICATION_TOKEN_TTL_MINUTES=5

# SMTP 邮件配置(用于发送密码重置邮件)
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_SECURITY=auto
SMTP_USERNAME=noreply@example.com
SMTP_PASSWORD=your_smtp_password
SMTP_FROM=noreply@example.com
SMTP_FROM_NAME=PicBed Switcher

# Redis 转换任务队列配置(开启后替代单进程内存队列)
REDIS_ENABLED=true
REDIS_ADDR=redis:6379
REDIS_PASSWORD=
REDIS_DB=0
REDIS_CONVERT_QUEUE=picbed:convert_tasks
CONVERT_WORKER_CONCURRENCY=1

部分配置说明

  • SMTP_SECURITY 可选值为 autosslstarttlsnone

    • 465 端口通常使用 ssl
    • 587 端口通常使用 starttls
    • 保留 auto 时,465 自动使用隐式 TLS,其他端口会在服务端支持时启用 STARTTLS
  • REDIS_ENABLED=true 时,转换任务会写入 Redis 队列并由后台 worker 消费

  • REDIS_ENABLED=false 时,会回退为本进程内存队列,适合不启 Redis 的本地开发

  • REDIS_CONVERT_QUEUE 指定 Redis List 队列名称,默认 picbed:convert_tasks;多个环境共用同一个 Redis 时建议使用不同队列名区分

  • CONVERT_WORKER_CONCURRENCY 控制同时处理的转换任务数量,默认 1 表示串行处理

3.3 构建镜像(可选)

如果不想使用阿里云镜像仓库的镜像,可直接在本地手动构建(默认使用阿里云镜像仓库地址):

# 在 deploy/ 目录下构建(构建上下文为项目根目录)
cd deploy
docker build -t picbed-switcher:latest -f Dockerfile ..

然后修改 deploy/docker-compose.ymlpicbed 服务的 image 字段为 picbed-switcher:latest

3.4 启动服务

docker-compose.yml 支持两种模式,按需选择:

模式一:新建 PostgreSQL 容器(默认)

首次启动会自动创建 picbed 数据库:

cd deploy
docker compose up -d

模式二:使用已有容器

.env 环境变量文件中确保数据库配置填入已有容器地址,并编辑 deploy/docker-compose.yml

  1. 注释掉 postgres 服务块
  2. 注释掉 picbed.depends_on
cd deploy
docker compose up -d

3.5 服务管理

# 查看服务状态
docker compose ps

# 查看实时日志
docker compose logs -f picbed-switcher

# 重启 picbed-switcher 服务
docker compose restart picbed-switcher

# 停止所有服务
docker compose down

# 停止并删除数据卷(谨慎!数据会丢失)
docker compose down -v

3.6 访问系统

服务启动后,访问以下地址:

  • 首页http://your-domain.com

    • 默认用户名admin
    • 默认邮箱admin@example.com
    • 默认密码123456
  • API 文档http://your-domain.com/swagger/index.html

  • 健康检查https://your-domain.com/health

3.7 宿主机 Nginx 反代(可选)

如需通过宿主机 Nginx 配置 HTTPS,将 deploy/docker-compose.yml 中的端口映射改为非 80 端口(如 8080:80),再配置外部 Nginx 代理:

3.7.1 HTTP 示例

server {
    listen 80;
    server_name your-domain.com;

    # 限制上传文件大小(可选)
    client_max_body_size 50m;

    # Gzip 压缩配置
    gzip on;
    gzip_vary on;
    gzip_proxied any;
    gzip_comp_level 6;
    gzip_types text/plain text/css text/xml text/javascript
               application/json application/javascript application/xml+rss
               application/rss+xml font/truetype font/opentype
               application/vnd.ms-fontobject image/svg+xml;
    gzip_min_length 1000;

    # 日志配置
    access_log /usr/local/nginx/logs/picbed-access.log;
    error_log /usr/local/nginx/logs/picbed-error.log warn;

    location / {
        proxy_pass http://127.0.0.1:8080;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        # 超时配置
        proxy_connect_timeout 600s;
        proxy_send_timeout 600s;
        proxy_read_timeout 600s;
    }
}

3.7.2 HTTPS 实例

HTTPS 示例(含 80→443 跳转,请替换证书路径):

# HTTP 80端口配置,自动重定向到HTTPS
server {
    listen 80;
    server_name your-domain.com;   # 修改为你的域名/主机名,例如:picbed.cn
    return 301 https://$host$request_uri;
}

# picbed 站点 HTTPS 配置
server {
    # listen 443 ssl http2;  # Nginx 1.25 以下版本写法
    listen 443 ssl;
    http2 on;
    server_name your-domain.com;   # 修改为你的域名/主机名,例如:picbed.cn

    # 证书路径(替换为实际证书文件)
    ssl_certificate     /usr/local/nginx/ssl/your-domain.com.pem;  # 例如:/usr/local/nginx/ssl/picbed.cn.pem
    ssl_certificate_key /usr/local/nginx/ssl/your-domain.com.key;  # 例如:/usr/local/nginx/ssl/picbed.cn.key

    # SSL安全优化
    ssl_protocols              TLSv1.2 TLSv1.3;
    ssl_prefer_server_ciphers  on;
    ssl_ciphers                ECDHE-RSA-AES128-GCM-SHA256:HIGH:!aNULL:!MD5:!RC4:!DHE;
    ssl_session_timeout        10m;
    ssl_session_cache          shared:SSL:10m;

    # 限制上传文件大小(可选)
    client_max_body_size 50m;

    # Gzip 压缩配置
    gzip on;
    gzip_vary on;
    gzip_proxied any;
    gzip_comp_level 6;
    gzip_types text/plain text/css text/xml text/javascript
               application/json application/javascript application/xml+rss
               application/rss+xml font/truetype font/opentype
               application/vnd.ms-fontobject image/svg+xml;
    gzip_min_length 1000;

    # 日志配置
    access_log /usr/local/nginx/logs/picbed-access.log;
    error_log /usr/local/nginx/logs/picbed-error.log warn;

    location / {
        proxy_pass http://127.0.0.1:8080;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        # 超时配置
        proxy_connect_timeout 600s;
        proxy_send_timeout 600s;
        proxy_read_timeout 600s;
    }
}

四、生产环境部署

4.1 克隆项目

git clone https://github.com/zyx3721/picbed-switcher.git /data/picbed-switcher
cd /data/picbed-switcher

4.2 后端构建与配置

  1. 进入后端目录下载相关依赖:
cd backend
go mod download
  1. 配置数据库连接等信息:
# 步骤1:复制模板文件
cp env.example .env

# 步骤2:编辑 .env,配置数据库连接等信息
vim .env
# 服务器配置
SERVER_HOST=localhost
SERVER_PORT=8080
GIN_MODE=release

# 数据库配置
DB_HOST=postgres
DB_PORT=5432
DB_NAME=picbed
DB_USER=postgres
DB_PASSWORD=your_database_password
DB_SSLMODE=disable

# JWT 配置
JWT_SECRET=your_jwt_secret_key
JWT_EXPIRE_HOURS=24

# 密码找回配置
APP_BASE_URL=http://your-domain.com
PASSWORD_RESET_TOKEN_TTL_MINUTES=5
EMAIL_VERIFICATION_TOKEN_TTL_MINUTES=5

# SMTP 邮件配置(用于发送密码重置邮件)
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_SECURITY=auto
SMTP_USERNAME=noreply@example.com
SMTP_PASSWORD=your_smtp_password
SMTP_FROM=noreply@example.com
SMTP_FROM_NAME=PicBed Switcher

# Redis 转换任务队列配置(开启后替代单进程内存队列)
REDIS_ENABLED=false
REDIS_ADDR=localhost:6379
REDIS_PASSWORD=
REDIS_DB=0
REDIS_CONVERT_QUEUE=picbed:convert_tasks
CONVERT_WORKER_CONCURRENCY=1

部分配置说明

  • SMTP_SECURITY 可选值为 autosslstarttlsnone

    • 465 端口通常使用 ssl
    • 587 端口通常使用 starttls
    • 保留 auto 时,465 自动使用隐式 TLS,其他端口会在服务端支持时启用 STARTTLS
  • REDIS_ENABLED=true 时,转换任务会写入 Redis 队列并由后台 worker 消费

  • REDIS_ENABLED=false 时,会回退为本进程内存队列,适合不启 Redis 的本地开发

  • REDIS_CONVERT_QUEUE 指定 Redis List 队列名称,默认 picbed:convert_tasks;多个环境共用同一个 Redis 时建议使用不同队列名区分

  • CONVERT_WORKER_CONCURRENCY 控制同时处理的转换任务数量,默认 1 表示串行处理

  1. 构建后端可执行文件:
go build -o picbed-backend cmd/main.go
  1. 运行后端服务:
# 方式1:前台运行(终端关闭则服务停止)
./picbed-backend

# 方式2:后台运行(日志输出到 app.log)
nohup ./picbed-backend > app.log 2>&1 &

# 方法3:加入 systemd 管理启动运行
# 服务配置参考如下,请自行修改相应目录路径
cat > /etc/systemd/system/picbed-backend.service <<EOF
[Unit]
Description=Picbed Switcher Backend Golang Service
After=network.target network-online.target
Wants=network-online.target

[Service]
Type=simple
WorkingDirectory=/data/picbed-switcher/backend
ExecStart=/data/picbed-switcher/backend/picbed-backend
Restart=on-failure
RestartSec=5
LimitNOFILE=65535
StandardOutput=journal
StandardError=journal
SyslogIdentifier=picbed-backend

[Install]
WantedBy=multi-user.target
EOF

# 重载服务配置并启动
systemctl daemon-reload
systemctl start picbed-backend

# 设置开机自启
systemctl enable --now picbed-backend

4.3 前端构建与配置

  1. 进入前端目录下载相关依赖:
cd frontend
npm install
  1. 构建前端项目:
npm run build

构建产物在 dist 目录,可部署到任何静态服务器(Nginx、Vercel、Netlify 等)。生产环境前端无需配置 API 地址,统一通过 Nginx /api/ 反向代理到后端。

4.4 配置Nginx反向代理

在服务器上准备前端目录(例如 /data/picbed-switcher/frontend/dist),将本地 dist 目录中的所有文件和子目录整体上传到该目录,保持结构不变,例如:

/data/picbed-switcher/admin/dist/
├── assets/
├── favicon.svg
├── index.html

Nginx 中的 root 应指向 包含 index.html 的目录本身(如 /data/picbed-switcher/frontend/dist ,可按实际路径调整),而不是上级目录。

4.4.1 HTTP 示例

配置 Nginx (按需替换域名/路径/证书),HTTP 示例

server {
    listen 80;
    server_name your-domain.com;   # 修改为你的域名/主机名,例如:picbed.cn

    # 前端静态资源目录(dist 构建产物)
    root /data/picbed-switcher/frontend/dist;  # 按实际部署路径修改
    index index.html;

    # 限制上传文件大小(可选)
    client_max_body_size 50m;

    # Gzip 压缩配置
    gzip on;
    gzip_vary on;
    gzip_proxied any;
    gzip_comp_level 6;
    gzip_types text/plain text/css text/xml text/javascript
               application/json application/javascript application/xml+rss
               application/rss+xml font/truetype font/opentype
               application/vnd.ms-fontobject image/svg+xml;
    gzip_min_length 1000;

    # 日志配置
    access_log /usr/local/nginx/logs/picbed-access.log;
    error_log /usr/local/nginx/logs/picbed-error.log warn;

    # 前端路由回退到 index.html(适配前端 history 模式)
    location / {
        try_files $uri $uri/ /index.html;
    }

    # 后端 API 反向代理
    location /api/ {
        proxy_pass http://127.0.0.1:8080;  # 与后端 API 相同地址
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_connect_timeout 60s;
        proxy_send_timeout 300s;
        proxy_read_timeout 300s;
    }

    # 后端 API 文档
    location /swagger/ {
        proxy_pass http://127.0.0.1:8080;  # 与后端 API 相同地址
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }

    # 健康检查
    location = /health {
        proxy_pass http://127.0.0.1:8080/health;
    }
}

4.4.2 HTTPS 示例

HTTPS 示例(含 80→443 跳转,请替换证书路径):

# HTTP 80端口配置,自动重定向到HTTPS
server {
    listen 80;
    server_name your-domain.com;   # 修改为你的域名/主机名,例如:picbed.cn
    return 301 https://$host$request_uri;
}

# picbed 站点 HTTPS 配置
server {
    # listen 443 ssl http2;  # Nginx 1.25 以下版本写法
    listen 443 ssl;
    http2 on;
    server_name your-domain.com;   # 修改为你的域名/主机名,例如:picbed.cn

    # 证书路径(替换为实际证书文件)
    ssl_certificate     /usr/local/nginx/ssl/your-domain.com.pem;  # 例如:/usr/local/nginx/ssl/picbed.cn.pem
    ssl_certificate_key /usr/local/nginx/ssl/your-domain.com.key;  # 例如:/usr/local/nginx/ssl/picbed.cn.key

    # SSL安全优化
    ssl_protocols              TLSv1.2 TLSv1.3;
    ssl_prefer_server_ciphers  on;
    ssl_ciphers                ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384;
    ssl_session_timeout        10m;
    ssl_session_cache          shared:SSL:10m;

    # 前端静态资源目录(dist 构建产物)
    root /data/picbed-switcher/frontend/dist;  # 按实际部署路径修改
    index index.html;

    # 限制上传文件大小(可选)
    client_max_body_size 50m;

    # Gzip 压缩配置
    gzip on;
    gzip_vary on;
    gzip_proxied any;
    gzip_comp_level 6;
    gzip_types text/plain text/css text/xml text/javascript
               application/json application/javascript application/xml+rss
               application/rss+xml font/truetype font/opentype
               application/vnd.ms-fontobject image/svg+xml;
    gzip_min_length 1000;

    # 日志配置
    access_log /usr/local/nginx/logs/picbed-access.log;
    error_log /usr/local/nginx/logs/picbed-error.log warn;

    # 前端路由回退到 index.html(适配前端 history 模式)
    location / {
        try_files $uri $uri/ /index.html;
    }

    # 后端 API 反向代理
    location /api/ {
        proxy_pass http://127.0.0.1:8080;  # 与后端 API 相同地址
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_connect_timeout 60s;
        proxy_send_timeout 300s;
        proxy_read_timeout 300s;
    }

    # 后端 API 文档
    location /swagger/ {
        proxy_pass http://127.0.0.1:8080;  # 与后端 API 相同地址
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }

    # 健康检查
    location = /health {
        proxy_pass http://127.0.0.1:8080/health;
    }
}

4.5 访问系统

服务启动后,访问以下地址:

  • 首页http://your-domain.com

    • 默认用户名admin
    • 默认邮箱admin@example.com
    • 默认密码123456
  • API 文档http://your-domain.com/swagger/index.html

  • 健康检查https://your-domain.com/health

五、API文档

5.1 认证接口

  • POST /api/auth/register - 用户注册
  • POST /api/auth/login - 用户名或邮箱登录
  • POST /api/auth/email/verify - 验证邮箱
  • POST /api/auth/email/verification - 重发邮箱验证邮件
  • POST /api/auth/password/forgot - 发送密码重置邮件
  • POST /api/auth/password/reset - 使用重置令牌设置新密码
  • GET /api/auth/profile - 获取当前用户信息
  • PUT /api/auth/password - 修改当前用户密码
  • PUT /api/auth/email - 修改当前用户邮箱

5.2 图床配置接口

  • GET /api/picbed/types - 获取支持的图床类型与配置字段
  • POST /api/picbed/configs - 添加图床配置
  • POST /api/picbed/configs/test - 测试未保存的图床配置
  • GET /api/picbed/configs - 获取所有图床配置
  • PUT /api/picbed/configs/:id - 更新图床配置
  • DELETE /api/picbed/configs/:id - 删除图床配置
  • PUT /api/picbed/configs/:id/default - 设置默认图床配置
  • POST /api/picbed/configs/:id/test - 测试已保存的图床配置

5.3 文档转换接口

  • POST /api/convert/analyze - 分析 Markdown 文档中的图片地址
  • POST /api/convert/process - 执行单个 Markdown 文档转换
  • POST /api/convert/batch - 批量执行 Markdown 文档转换
  • POST /api/convert/local-batch - 批量上传 Markdown 中引用的本地图片并替换地址
  • POST /api/convert/local-tasks - 创建本地图片上传替换后台任务并加入队列
  • POST /api/convert/tasks - 创建转换任务并加入后台队列
  • GET /api/convert/tasks - 获取转换任务列表
  • GET /api/convert/tasks/:id - 获取转换任务详情
  • GET /api/convert/records - 获取转换历史
  • GET /api/convert/records/:id - 获取转换历史详情

POST /api/convert/local-batchPOST /api/convert/local-tasks 使用 multipart/form-data 提交:manifest 为本地批量上传清单 JSON,图片文件字段按 manifest.documents[].images[].file_key 指定。前者为同步处理接口,后者会创建后台任务并复用转换任务队列。

5.4 基础接口

  • GET /health - 服务健康检查

以上接口除注册、登录、邮箱验证、密码找回/重置和健康检查外,均需要在请求头中携带 Authorization: Bearer <token>

六、使用说明

6.1 注册/登录

首次使用可使用默认账号或注册新账号,已有账号可直接登录。

6.2 配置图床

在"图床配置"页面添加您使用的图床配置信息:

  • GitHub:需要提供Personal Access Token、仓库信息
  • Gitee:需要提供Private Token、仓库信息
  • 腾讯云COS:需要提供SecretId、SecretKey、存储桶信息
  • 阿里云OSS:需要提供AccessKeyId、AccessKeySecret、存储桶信息
  • 七牛云:需要提供AccessKey、SecretKey、存储桶信息
  • 百度云 BOS:需要提供AccessKeyId、SecretAccessKey、存储桶和地域
  • 华为云 OBS:需要提供AccessKeyId、SecretAccessKey、存储桶和地域
  • 又拍云:需要提供服务名、操作员、密码和加速域名
  • MinIO:需要提供Endpoint、AccessKey、SecretKey、存储桶,可按需填写地域、SSL 开关和公开访问域名
  • EasyImage:需要提供 API 地址和 Token
  • 其他图床:需要提供兼容上传接口的 API 地址、Token 等信息

6.2.1 文件命名格式说明

除 EasyImage 外,图床配置中可填写“文件命名格式”,用于控制图片上传到目标图床后的对象路径和文件名。留空时使用默认格式:

{y}/{m}/{d}/{origin}{ext}

例如在 2026-05-18 上传 cover.png,默认会生成类似:

2026/05/18/cover.png

可用变量如下:

变量 说明 示例
{y} 当前年份,四位数 2026
{m} 当前月份,两位数 05
{d} 当前日期,两位数 18
{timestamp} 当前 Unix 秒级时间戳 1779087600
{origin} 原始文件名,不包含扩展名 cover
{name} {origin} 相同,原始文件名不含扩展名 cover
{filename} 原始完整文件名,包含扩展名 cover.png
{ext} 原始扩展名,包含点号 .png
{hash} 图片内容的 SHA-1 哈希值 9f2a...
{random} 8 位随机十六进制字符串 a1b2c3d4
{rand:N} 指定长度的随机十六进制字符串,N 为正整数 {rand:6} -> a1b2c3

常见格式示例:

# 按日期目录保存,保留原文件名
{y}/{m}/{d}/{filename}

# 按日期目录保存,文件名增加随机串,降低重名概率
{y}/{m}/{d}/{origin}-{rand:6}{ext}

# 使用内容哈希命名,适合去重和缓存
images/{hash}{ext}

# 使用时间戳和原文件名组合
uploads/{timestamp}-{origin}{ext}

命名格式中的路径分隔符 / 会作为图床对象路径使用;非法字符、空格和危险路径片段会被自动清理或替换为 -,避免生成不安全的对象名。

6.3 转换文档

  1. 在"文档转换"页面上传Markdown文档
  2. 系统自动识别文档中的图床类型
  3. 选择目标图床(从已配置的图床中选择)
  4. 点击"开始转换"按钮
  5. 等待转换完成
  6. 下载转换后的文档

说明

  • 批量转换和本地上传替换都会创建持久化转换任务。开启 Redis 后,任务 ID 会写入 REDIS_CONVERT_QUEUE 指定的 Redis 队列,由后台 worker 按 CONVERT_WORKER_CONCURRENCY 配置的并发数消费;未开启 Redis 时会回退为当前后端进程内的内存队列,适合本地开发或单实例轻量使用。服务启动时会自动重新入队数据库中仍处于 queued 状态的任务,前端刷新后也会根据任务 ID 继续轮询进度。
  • Redis 队列按“转换任务”维度排队,而不是按单个 Markdown 文档排队。一次批量转换或本地上传即使包含多个文档,也只会写入一个任务 ID;多个用户或多次点击创建的多个转换任务,才会在 REDIS_CONVERT_QUEUE 中排队等待 worker 消费。
  • 转换结果预览/差异对比用于快速查看变化摘要,当前最多展示前 20 条变化;完整转换内容不受该限制,可通过下载转换后的文档查看。

6.4 本地上传

当 Markdown 文档中的图片地址为本地路径时,可使用"本地上传"页面将图片上传到目标图床并自动替换文档内容。

  1. 在"本地上传"页面上传或拖动一个或多个 Markdown 文档
  2. 上传本地图片文件,或选择包含图片的目录
  3. 系统会匹配 Markdown 中的本地图片引用,例如 ./images/a.pngimages/a.pngC:\Users\demo\Pictures\a.png<img src="./images/a.png">
  4. 确认缺失数量为 0 后,选择目标图床配置
  5. 点击"上传并替换"按钮
  6. 下载替换完成后的 Markdown 文档

本地上传仅处理本地图片引用,文档中的 http://https:// 远程图片地址会保持不变。如需转换远程图片地址,请使用"文档转换"页面。

本地上传会创建后台任务并复用 Redis/内存转换队列。任务创建时会先将本地图片文件上传到后端临时任务目录,因此浏览器刷新后可根据任务 ID 自动恢复进度并同步转换结果;任务处理完成后会自动清理对应临时文件。

6.5 查看历史

在"转换历史"页面可以查看所有转换记录,包括转换时间、源图床、目标图床、转换状态、图片数量等信息。

点击任意历史记录行可打开详情弹窗,查看该次转换的文件名、图床类型、状态、图片数和错误信息。详情中的"替换明细"会列出每张图片的源地址、目标地址和转换状态;地址较长时表格会省略显示,鼠标悬停可查看完整地址。

如果该记录包含转换后的内容,可在详情中点击"下载转换结果"下载完整 Markdown 文档。

七、版本历史

v3.0.1 - 2026-05-19

  • 优化 Docker 环境启动日志,.env 文件不存在时静默跳过加载。
  • 部署环境示例补充 GIN_MODE=release
  • 历史记录列表新增选择列、全选复选框和批量删除按钮。
  • 新增 DELETE /api/convert/records 接口,删除历史时同步清理替换明细。
  • 历史记录超过 15 行后启用内部滚动并隐藏滚动条。
  • 详细更新日志见 verchanglog/v3.0.1.md

v3.0.0 - 2026-05-19

  • 新增邮箱验证、重发验证邮件和邮箱可达性预检查,未验证邮箱不能使用密码找回。
  • 新增持久化转换任务队列,支持 Redis worker 和本进程内存队列回退。
  • 新增配置可用性测试、转换结果预览/差异对比和历史记录详情页。
  • 新增百度云 BOS、华为云 OBS、又拍云 USS、MinIO 图床适配,并扩展图床来源识别。
  • 新增 /api/convert/local-tasks,本地上传支持后台任务、进度轮询和刷新恢复。
  • 优化批量转换本地路径处理、任务结果回填、MinIO SSL 配置选择和本地上传目标配置下拉体验。
  • 详细更新日志见 verchanglog/v3.0.0.md

v2.1.0 - 2026-05-18

  • 新增忘记密码功能,支持通过邮箱接收一次性密码重置链接。
  • 新增 /api/auth/password/forgot/api/auth/password/reset 接口。
  • 新增 SMTP 邮件配置,支持 autosslstarttlsnone 安全模式和发件人显示名。
  • 新增 HTML 卡片式密码重置邮件模板,并保留纯文本 fallback。
  • 修复重置链接场景下前端工作区上下文类型缺失导致的构建失败问题。
  • 详细更新日志见 verchanglog/v2.1.0.md

v2.0.0 - 2026-05-18

  • 新增本地上传功能,可将 Markdown 中引用的本地图片上传到目标图床并替换为远程地址。
  • 新增全局处理中弹窗,批量转换和本地上传替换时可查看当前处理进度、成功数与失败数。
  • 批量转换与本地上传替换改为逐文档执行,降低长耗时任务期间误刷新和重复提交风险。
  • 新增 /api/convert/local-batch 接口,支持通过 multipart/form-data 提交本地图片和路径映射清单。
  • 详细更新日志见 verchanglog/v2.0.0.md

v1.0.0 - 2026-05-18

  • 首个正式版本,完成图床转站助手核心功能闭环。
  • 支持用户认证、图床配置管理、Markdown 图片地址分析、单文档转换、批量转换和转换历史记录。
  • 支持 GitHub、Gitee、腾讯云 COS、阿里云 OSS、七牛云、百度云 BOS、华为云 OBS、又拍云、MinIO、EasyImage 和兼容通用接口的图床服务。
  • 提供 Vue 3 前端工作台、Go/Gin 后端 API、PostgreSQL 数据库初始化、Docker Compose 部署配置和 Swagger 接口文档。
  • 详细更新日志见 verchanglog/v1.0.0.md

八、安全说明

  • 图床 Token、密钥等配置采用 AES-256-GCM 加密存储
  • 用户密码使用 bcrypt 单向哈希存储
  • 接口采用JWT认证,防止未授权访问
  • 接口配置了速率限制,防止高频恶意请求
  • 前端展示敏感信息时进行脱敏处理

九、注意事项

  1. API限制:部分图床(如GitHub)有API速率限制,请合理使用
  2. 文件大小:建议单个Markdown文档不超过10MB
  3. 本地上传限制:本地图片需通过页面选择文件或目录授权后上传,系统不会直接读取用户电脑上的任意路径
  4. 图片格式:不同图床对图片格式要求不同,转换时请注意兼容性
  5. 数据备份:建议定期备份PostgreSQL数据库
  6. 密钥安全:请妥善保管 JWT_SECRET,生产环境不要使用示例值

十、常见问题

Q: 转换失败怎么办?

A: 请检查:

  1. 图床配置是否正确
  2. Token/密钥是否有效
  3. 网络连接是否正常
  4. 图床API是否有速率限制

Q: 如何备份数据?

A: 使用以下命令备份PostgreSQL数据库:

docker exec picbed-postgres pg_dump -U your_user picbed_switcher > backup.sql

Q: 如何恢复数据?

A: 使用以下命令恢复数据库:

docker exec -i picbed-postgres psql -U your_user picbed_switcher < backup.sql

十一、许可证

本项目采用 MIT License 开源协议。

MIT License 是一个宽松的开源许可证,允许您自由地使用、复制、修改、合并、发布、分发、再许可和/或销售本软件的副本。唯一的要求是在所有副本或重要部分中保留版权声明和许可声明。

十二、致谢

感谢以下开源项目和技术社区的支持:

  • Gin - 高性能的 Go Web 框架
  • GORM - Go ORM 框架
  • PostgreSQL - 稳定可靠的开源关系型数据库
  • Vue - 渐进式 JavaScript 框架
  • Vite - 快速前端构建工具
  • Lucide - 简洁一致的开源图标库
  • MinIO Go Client - S3 兼容对象存储客户端
  • EasyImage - 简单易用的自建图床方案

特别感谢所有为本项目贡献代码、提出建议和报告问题的开发者。

十三、联系方式

如果您在使用过程中遇到问题,或有任何建议和反馈,欢迎通过以下方式联系:


⭐ 如果这个项目对您有帮助,欢迎 Star 支持!

About

一款支持多主流图床的 Markdown 文档图床地址批量转换工具平台。

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages