{"id":51615922,"url":"https://github.com/itcuihao/firefly-media-gateway","last_synced_at":"2026-07-12T13:30:58.472Z","repository":{"id":364341328,"uuid":"1254263287","full_name":"itcuihao/firefly-media-gateway","owner":"itcuihao","description":"  自托管的媒体存储网关，通过 Telegram   作为无限存储后端，提供统一的上传、访问、删除与元数据管理接口，支持 REST API 和    S3 兼容 API，内置管理控制台。","archived":false,"fork":false,"pushed_at":"2026-06-12T16:09:30.000Z","size":11323,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-12T17:29:30.277Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itcuihao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-30T10:51:36.000Z","updated_at":"2026-06-12T16:09:35.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/itcuihao/firefly-media-gateway","commit_stats":null,"previous_names":["itcuihao/firefly-media-gateway"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/itcuihao/firefly-media-gateway","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcuihao%2Ffirefly-media-gateway","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcuihao%2Ffirefly-media-gateway/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcuihao%2Ffirefly-media-gateway/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcuihao%2Ffirefly-media-gateway/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itcuihao","download_url":"https://codeload.github.com/itcuihao/firefly-media-gateway/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcuihao%2Ffirefly-media-gateway/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35393398,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-12T02:00:06.386Z","response_time":87,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-07-12T13:30:53.319Z","updated_at":"2026-07-12T13:30:58.467Z","avatar_url":"https://github.com/itcuihao.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"icon.png\" width=\"120\" alt=\"Firefly Media Gateway\" /\u003e\n\u003c/div\u003e\n\n# firefly-media-gateway\n\nA self-hosted media storage gateway that uses Telegram as unlimited storage backend. Provides unified upload, access, deletion and metadata management via REST and S3-compatible APIs, with a built-in admin console.\n\n自托管的媒体存储网关，通过 Telegram 作为无限存储后端，提供统一的上传、访问、删除与元数据管理接口，支持 REST API 和 S3 兼容 API，内置管理控制台。\n\n## 功能\n\n- 统一上传接口（图片/视频）\n- 统一访问接口（二进制流式代理，支持 Range）\n- 元数据入库（默认 SQLite，可配置 PostgreSQL）\n- Provider 抽象（`tg` 已实现，`r2` 占位）\n- 基础 Bearer Token 鉴权\n- S3 兼容 API\n- 内嵌管理 UI（`/admin/`，Vue 3 + Naive UI）\n\n## API\n\n### REST API\n\n- `POST   /api/v1/media/upload` — 上传文件\n- `GET    /api/v1/media/{mediaId}` — 获取媒体二进制内容\n- `GET    /api/v1/media/{mediaId}/meta` — 获取元数据\n- `GET    /api/v1/media/{mediaId}/stream` — 流式代理（支持 Range）\n- `DELETE /api/v1/media/{mediaId}` — 删除文件\n- `GET    /api/v1/media` — 列举文件\n- `GET    /api/v1/health` — 健康检查\n\n### S3 兼容 API\n\n- `PUT    /s3/{bucket}/{project}/{usage}/{filename}` — 上传\n- `GET    /s3/{bucket}?asset_id=xxx` — 下载\n- `DELETE /s3/{bucket}?asset_id=xxx` — 删除\n- `GET    /s3/{bucket}` — 列举\n\n## 上传限制\n\n- 图片：`jpg/jpeg/png/webp`，最大 `10MB`\n- 视频：`mp4/webm/mov`，最大 `120MB`\n\n## 鉴权\n\n以下接口需要在请求头中携带 Token：\n\n```text\nAuthorization: Bearer \u003cMEDIA_GATEWAY_TOKEN\u003e\n```\n\n`GET /api/v1/media/{mediaId}` 与 `GET /api/v1/media/{mediaId}/stream` 均返回媒体二进制内容，需要鉴权。`/stream` 会代理底层 provider 的文件流；单文件支持透传 `Range` 请求，分片文件暂不支持 Range。\n\n## 数据库\n\n默认使用无 CGO 的 SQLite，数据库文件为 `data/media_gateway.db`，启动时自动建表，无需额外配置。\n\n如需 PostgreSQL：\n\n```text\nDATABASE_DRIVER=postgres\nDATABASE_URL=postgres://user:pass@host:5432/dbname?sslmode=disable\n```\n\nPostgreSQL 初始化 SQL：`migrations/001_init.sql`\n\n核心表：`media_assets`\n\n---\n\n## 部署\n\n### 架构概览\n\n```\n┌─────────────────────────────────────────────────────────────────┐\n│                        业务方 / SDK                              │\n└────────────────────────────┬────────────────────────────────────┘\n                             │\n        ┌────────────────────┴────────────────────┐\n        │                                         │\n   ┌────▼────┐                              ┌────▼────┐\n   │  Mode 1 │                              │  Mode 2 │\n   │  Worker │                              │ Go +    │\n   │  Only   │                              │ Worker  │\n   └──────────┘                              └────┬────┘\n        │                                        │\n        │                                  ┌────▼────┐\n        │                                  │   Go    │\n        │                                  │  Direct │\n        │                                  └──────────┘\n        │                                        │\n        └────────────────┬───────────────────────┘\n                         │\n                   ┌─────▼─────┐\n                   │ Telegram  │\n                   │  Storage  │\n                   └───────────┘\n```\n\n| 模式 | 组件 | 优点 | 缺点 |\n|------|------|------|------|\n| **Worker Only** | CF Workers | 无服务器、全球加速 | 无枚举能力 |\n| **Go + Worker** | Go 后端 + Workers | 完整功能、边缘加速 | 需管理服务器 |\n| **Go Direct** | Go 后端直连 TG | 完整功能、无依赖 | 无边缘加速 |\n\n### 前置准备\n\n| 项目 | 说明 |\n|------|------|\n| Telegram Bot Token | 从 [@BotFather](https://t.me/BotFather) 创建 Bot 获取 |\n| Telegram Chat ID | 创建群组/频道，将 Bot 加入，获取群组 ID（负数，如 `-1001234567890`） |\n| MEDIA_GATEWAY_TOKEN | 自定义一个强密钥，用于 API 鉴权 |\n| 服务器 + 域名 | 运行 Docker，提供公网访问（`PUBLIC_BASE_URL`） |\n| Cloudflare 账号 | 仅 Worker 相关模式需要（免费版即可） |\n\n---\n\n### 快速启动（Go Direct，最简模式）\n\n```bash\ncp .env.example .env\n# 编辑 .env，填写 TELEGRAM_BOT_TOKEN / TELEGRAM_CHAT_ID / MEDIA_GATEWAY_TOKEN\ndocker compose up --build\n```\n\n服务默认监听 `http://localhost:8080`。\n\n\u003e Docker 三阶段构建自动完成：Node.js 编译前端 → Go 编译二进制（`go:embed` 嵌入前端）→ Distroless 运行镜像。\n\n#### 本地运行（不走 Docker）\n\n```bash\ncp .env.example .env\nset -a; source .env; set +a\nGOCACHE=\"$(pwd)/.gocache\" GOMODCACHE=\"$(pwd)/.gomodcache\" go run ./cmd/server\n```\n\n---\n\n### 模式 1：Worker Only（轻量模式）\n\n```bash\ncd workers\nnpm install\n\n# 配置 secrets\nwrangler secret put TELEGRAM_BOTS_CONFIG\n# 输入: {\"bot1\":{\"token\":\"xxx\",\"default_group\":\"-100xxx\"}}\n\n# 可选：鉴权 token\nwrangler secret put AUTH_TOKEN\n\n# 部署\nnpm run deploy\n```\n\n**环境变量：**\n\n| 变量 | 必填 | 说明 |\n|------|------|------|\n| `TELEGRAM_BOTS_CONFIG` | 是 | JSON 格式多 Bot 配置 |\n| `AUTH_TOKEN` | 否 | API 鉴权 Token |\n\n**API 端点：**\n\n```\nPOST   /upload           # 上传文件\nGET    /get              # 获取文件 URL\nDELETE /delete           # 删除文件\nGET    /health           # 健康检查\n```\n\n---\n\n### 模式 2：Go + Worker（推荐）\n\n```\n┌─────────────────┐\n│   S3 / HTTP     │\n└────────┬────────┘\n┌────────▼────────┐\n│  Go Backend     │\n│  - 元数据 CRUD  │\n│  - S3 Gateway   │\n└────────┬────────┘\n┌────────▼────────┐\n│  CF Worker      │\n│  - 上传/下载代理 │\n└────────┬────────┘\n┌────────▼────────┐\n│  Telegram       │\n└─────────────────┘\n```\n\n#### 1. 部署 Worker\n\n```bash\ncd workers\nnpm install\nwrangler secret put TELEGRAM_BOTS_CONFIG\nwrangler secret put AUTH_TOKEN\nnpm run deploy\n```\n\n#### 2. 部署 Go 后端\n\n```bash\ndocker build -t firefly-media-gateway .\n\ndocker run -d \\\n  -e STORAGE_MODE=proxy \\\n  -e WORKER_BASE_URL=https://your-worker.workers.dev \\\n  -e WORKER_AUTH_TOKEN=your_worker_token \\\n  -e MEDIA_GATEWAY_TOKEN=your_api_token \\\n  -e PUBLIC_BASE_URL=https://your-api.com \\\n  -v media_gateway_data:/app/data \\\n  -p 8080:8080 \\\n  firefly-media-gateway\n```\n\n**环境变量：**\n\n| 变量 | 必填 | 说明 |\n|------|------|------|\n| `STORAGE_MODE` | 是 | 设为 `proxy` |\n| `WORKER_BASE_URL` | 是 | Worker 服务 URL |\n| `WORKER_AUTH_TOKEN` | 是 | Worker 鉴权 Token |\n| `MEDIA_GATEWAY_TOKEN` | 是 | Go API 鉴权 Token |\n| `PUBLIC_BASE_URL` | 是 | 公共访问 URL |\n| `DATABASE_DRIVER` | 否 | `sqlite` 或 `postgres`，不填时根据 `DATABASE_URL` 自动判断 |\n| `DATABASE_URL` | 否 | 不填默认 SQLite: `data/media_gateway.db` |\n\n---\n\n### 模式 3：Go Direct（直连模式）\n\n**环境变量：**\n\n| 变量 | 必填 | 说明 |\n|------|------|------|\n| `STORAGE_MODE` | 是 | 设为 `direct` |\n| `TELEGRAM_BOTS_CONFIG` | 是* | JSON 格式多 Bot 配置 |\n| `TELEGRAM_BOT_TOKEN` | 是* | 单 Bot Token（兼容） |\n| `TELEGRAM_CHAT_ID` | 是* | 单 Bot Chat ID（兼容） |\n| `MEDIA_GATEWAY_TOKEN` | 是 | Go API 鉴权 Token |\n| `PUBLIC_BASE_URL` | 是 | 公共访问 URL |\n| `DATABASE_DRIVER` | 否 | `sqlite` 或 `postgres`，不填时根据 `DATABASE_URL` 自动判断 |\n| `DATABASE_URL` | 否 | 不填默认 SQLite: `data/media_gateway.db` |\n\n\\* 多 Bot 配置时使用 `TELEGRAM_BOTS_CONFIG`，单 Bot 时使用 `TELEGRAM_BOT_TOKEN` + `TELEGRAM_CHAT_ID`\n\n**单 Bot：**\n\n```bash\ndocker run -d \\\n  -e STORAGE_MODE=direct \\\n  -e TELEGRAM_BOT_TOKEN=123456:ABC-DEF \\\n  -e TELEGRAM_CHAT_ID=-1001234567890 \\\n  -e MEDIA_GATEWAY_TOKEN=secret \\\n  -e PUBLIC_BASE_URL=https://api.example.com \\\n  -v media_gateway_data:/app/data \\\n  -p 8080:8080 \\\n  firefly-media-gateway\n```\n\n**多 Bot：**\n\n```bash\ndocker run -d \\\n  -e STORAGE_MODE=direct \\\n  -e TELEGRAM_BOTS_CONFIG='{\"bot1\":{\"token\":\"xxx\",\"default_group\":\"-100xxx\"},\"bot2\":{\"token\":\"yyy\",\"default_group\":\"-100yyy\"}}' \\\n  -e MEDIA_GATEWAY_TOKEN=secret \\\n  -e PUBLIC_BASE_URL=https://api.example.com \\\n  -v media_gateway_data:/app/data \\\n  -p 8080:8080 \\\n  firefly-media-gateway\n```\n\n---\n\n### 客户端使用示例\n\n#### cURL\n\n```bash\n# 上传文件\ncurl -X POST https://api.example.com/api/v1/media \\\n  -H \"Authorization: Bearer $TOKEN\" \\\n  -F \"file=@image.jpg\" \\\n  -F \"project=myproject\" \\\n  -F \"usage=cover\"\n\n# 获取文件\ncurl https://api.example.com/api/v1/media/{asset_id} \\\n  -H \"Authorization: Bearer $TOKEN\"\n\n# 删除文件\ncurl -X DELETE https://api.example.com/api/v1/media/{asset_id} \\\n  -H \"Authorization: Bearer $TOKEN\"\n```\n\n#### AWS S3 SDK (Go)\n\n```go\ncfg, _ := config.LoadDefaultConfig(context.TODO(),\n    config.WithEndpointURL(\"https://api.example.com\"),\n    config.WithRegion(\"auto\"),\n)\nclient := s3.NewFromConfig(cfg)\n\n// 上传\n_, err := client.PutObject(context.TODO(), \u0026s3.PutObjectInput{\n    Bucket: aws.String(\"media-assets\"),\n    Key:    aws.String(\"myproject/cover/image.jpg\"),\n    Body:   bytes.NewReader(data),\n})\n\n// 下载\nresp, _ := client.GetObject(context.TODO(), \u0026s3.GetObjectInput{\n    Bucket: aws.String(\"media-assets\"),\n    Key:    aws.String(\"myproject/cover/image.jpg\"),\n})\n```\n\n---\n\n### 生产部署（CI/CD）\n\n推送 `v*` 标签时，GitHub Actions 自动 SSH 到服务器执行 `git pull → docker build → docker compose up`。\n\n#### 1. 服务器准备\n\n```bash\n# 克隆仓库到部署目录\ngit clone https://github.com/your-org/firefly-media-gateway.git /opt/firefly-media-gateway\ncd /opt/firefly-media-gateway\n\n# 创建 .env（不进 git）\ncp .env.example .env\n# 编辑填写必要配置，不设 DATABASE_URL 则默认 SQLite\n```\n\n`.env` 示例：\n\n```bash\nSTORAGE_MODE=direct\nTELEGRAM_BOT_TOKEN=xxx\nTELEGRAM_CHAT_ID=-100xxx\nMEDIA_GATEWAY_TOKEN=your_strong_secret\nPUBLIC_BASE_URL=https://your-domain.com\n```\n\n#### 2. 配置 GitHub Secrets\n\n在仓库 Settings → Secrets and variables → Actions 中添加：\n\n| Secret | 说明 |\n|--------|------|\n| `DEPLOY_HOST` | 服务器 IP |\n| `DEPLOY_USER` | SSH 用户名 |\n| `DEPLOY_SSH_KEY` | SSH 私钥 |\n| `DEPLOY_PORT` | SSH 端口（可选，默认 22） |\n\n#### 3. 触发部署\n\n```bash\ngit tag v1.0.0\ngit push --tags\n```\n\n也可在 GitHub Actions 页面手动触发（`workflow_dispatch`）。\n\n---\n\n### 验证部署\n\n```bash\n# Go 后端\ncurl https://your-api.com/api/v1/health\n\n# Worker\ncurl https://your-worker.workers.dev/health\n```\n\n### 故障排查\n\n| 问题 | 解决方案 |\n|------|----------|\n| Worker 上传失败 | 检查 `TELEGRAM_BOTS_CONFIG` JSON 格式是否正确 |\n| Go 无法连接 Worker | 检查 `WORKER_BASE_URL` 和 `WORKER_AUTH_TOKEN` |\n| S3 列举返回空 | 检查数据库连接和索引 |\n| 文件 URL 404 | 检查 `PUBLIC_BASE_URL` 配置 |\n| SQLite 错误 | 确认 `/app/data` 目录有写权限 |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitcuihao%2Ffirefly-media-gateway","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitcuihao%2Ffirefly-media-gateway","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitcuihao%2Ffirefly-media-gateway/lists"}