Skip to content
pigeonboxPublic

About

FilesCodeBox 文件快递柜 — 匿名口令分享文本与文件的开源自托管平台(Go + Vue3)。生态装配仓:make setup 一键拉齐全部模块。Self-hosted anonymous passcode file sharing.

Topics

Resources

Contributing

Security policy

Stars

12 stars

Watchers

1 watching

Forks

Repository files navigation

PigeonBox

PigeonBox(umbrella) · 文件快递柜

License Tag Downloads

高性能文件/文本匿名分享平台(PigeonBox · 文件快递柜)的装配仓库:本仓不含业务代码,只负责把各模块仓库拉齐成一个可开发、可构建、可部署的完整工作区。

🗂️ 组织主页有生态总览与各形态(Docker / Kubernetes / 桌面 / NAS)快速开始。 拆分前的单仓库完整版本保留在 legacy 分支(全量历史)。 English overview: README.en-US.md

模块仓库

仓库 角色 版本
contracts 契约层:错误码 + Thrift 生成类型 + IDL 真相源(纯类型,零业务依赖) v0.23.0
core 业务核心库:17 个域服务(含 config 系统配置中心) + repo/storage + bootstrap.Bootstrap() 库入口 v0.40.0
server 独立部署应用:main 薄壳 + pb CLI(含 p2p 四支联邦子命令) + 配置模板 + Dockerfile(0.9.0 起纯后端) v5.8.0
frontend 前端壳:neutral 产物 + nginx 分离镜像(随 server 同版本发布;平台宿主适配器归各平台仓 web/) 随 server 同 v*
frontend-core 公共前端 core:平台无关应用(Vue3+TS+Vite+Element Plus)+宿主适配器 SPI,Release 源码 tgz 消费 v0.18.0
desktop 桌面客户端:Tauri 2 托盘常驻,连接任意 PigeonBox 服务器(纯客户端,直传请用 PigeonBeam) desktop-v5.8.0
fnos 飞牛 fnOS 原生应用(fpk 单进程+开放平台 SSO 深度融合+随包 p2pc;Docker 镜像已停发) v5.8.0
openwrt OpenWrt/iStoreOS 原生包(ipk+apk 双格式):procd 托管+UCI 配置+LuCI 集成,单端口 12345 内置 Web 界面,随包 p2pc v5.8.0
synology 群晖 DSM 7.2+ 套件(SPK,noarch):Container Manager 编排,向导设端口/数据目录/管理员密码 v5.8.0
qnap 威联通 QTS 原生应用(QPKG,x86_64+arm_64):单进程免 Container Station(QTS 4.5+),QTS 账号 SSO 免登录,随包 p2pc v5.8.0
ugreen 绿联 UGOS Pro 部署包:Docker→项目 compose 一键粘贴(含国内加速编排) v5.8.0
terramaster 铁威马 TOS 5/6/7 部署包:Docker Manager 项目导入 v5.8.0
p2p PigeonBeam(信鸽直传):设备直传独立应用 —— p2pc CLI/网页客户端(wire 协议 v4)+ 联邦注册中心与加密中继底座 v0.9.7
charts Kubernetes Helm Chart:前后端分离双 Deployment(含多副本 public/admin 双拓扑) pigeonbox-2.0.132

kit 仓已归档(2026-10-16):28 个零生态依赖通用包已并入外部地基库 oekit 的模块矩阵,消费方(core/p2p/fnos/openwrt/qnap)已切过去。迁移映射以 docs/KIT-OEKIT-MIGRATION.md 为现行真相源(kit README 的表有 2 条失效:uidgen/validator 归宿已更正为 github.com/oekit/kitx);归档前置检查流程亦见该文。

依赖方向(单向,CI 守护):server / fnos / openwrt / qnap ──► core ──► contracts;前端 壳仓与各平台仓 web/ ──► frontend-core(tgz) ──► contracts(TS d.ts);core、p2p 按需消费 oekit 地基层;p2p 为业务链零依赖叶子仓(Go 模块零耦合;仅 NAS 三端 fnos/qnap/openwrt 在打包期按钉版拉取 p2pc 二进制——server 镜像与桌面端已不再随包)

快速开始

git clone https://github.com/pigeonbox/pigeonbox.git && cd pigeonbox

make setup     # 拉齐模块仓库(幂等,重复执行=更新)
make test      # 全仓测试(Go 各模块 + 前端 typecheck)
make lint      # golangci-lint 各 Go 模块(CI 同款门禁)
make build     # workspace 联编
make smoke     # 起 server 跑冒烟(健康检查/admin 登录;49 项全量断言见下一行)
# bash scripts/smoke-full.sh   # 全能力真机冒烟(49 项断言,含临时 Redis)

纯 Docker 部署(详见 docs/DEPLOY-COMPOSE.md):

cp .env.example .env          # 不改也能起:管理员留空 ⇒ 启动后打开站点走 /setup 首启向导建号
docker compose up -d          # ghcr 发布镜像;前端入口 http://localhost:12345(PB_API_PORT,默认 12345),前端镜像同时反代 API,server 不发布端口
# BUILD=1 make compose-up     # 本地构建(需先 make setup)
# docker compose --profile nginx up -d   # 加 nginx 反代(须配 PB_TRUSTED_PROXIES,见部署指南;PB_HTTP_PORT 默认 80 仅作用于此 profile)

管理员账号不用预先想好:3.0.0 起不再播种弱口令 admin/admin123。compose 入口在检测到 PB_ADMIN_PASSWORD 为空时自动切到 /setup 首启向导模式——启动后打开 http://localhost:12345 走完向导即建好管理员(站点名、密码、有效期策略一页配完)。想无人值守再在 .env 预设 PB_ADMIN_PASSWORD。公网部署建议再加 PB_SETUP_TOKEN=<任意非空值>(未初始化实例的 /setup 无鉴权,谁先访问谁建号)。JWT 密钥留空时首启自动生成并持久化到 ./data/.jwt_secret。

直跑 server 二进制(不经编排层)且 PB_PRODUCTION=1 时,留空密码会拒绝启动——那种场景请显式设 PB_ADMIN_PASSWORD 或 PB_DISABLE_DEFAULT_ADMIN=true。

工作区布局(setup 后)

pigeonbox/           ← 本仓(装配层:脚本/联编/编排/发布列车/文档站)
├── go.work             # contracts+core+server+fnos+openwrt+qnap+p2p+kit 本地联编
├── contracts/  core/  server/  frontend/  frontend-core/  fnos/  openwrt/  p2p/  kit/   ← 独立 git 仓库(gitignore 掉)
├── synology/  qnap/  ugreen/  terramaster/   ← NAS 打包四仓(qnap 为原生 QPKG 含 Go,其余纯 shell,同样 gitignore)
├── release/train.yaml  ← 全生态版本真相源(发布列车)
└── data/               ← compose 数据卷

各模块仓库独立开发、独立 CI、独立发版;server/Dockerfile 的构建上下文恰好就是本目录,make docker 直接出完整镜像。

发版

全生态版本经发布列车统一驱动(真相源 release/train.yaml,编排器 release/trainctl 状态机,禁止绕过手改钉版):

make train-bump TRAIN=x.y.z SET="core=vX.Y.Z core_pin=vX.Y.Z"   # 开新列车:结构化写版本点→各仓 PR→自动合并
make train-verify                            # train.yaml ↔ 全生态对账(CI 每日+PR 同款)
make train-advance                           # 手动推进状态机(正常由组件回调/定时 sweep 自动推进)

列车按依赖序自动推 tag(库线 contracts/kit/core/p2p/frontend-core 先行 → frontend → server → 七终端 → desktop),机器人账号推送天然触发各仓 Release 流水线:多架构镜像推 ghcr(见各仓 release.yml): ghcr.io/pigeonbox/server · ghcr.io/pigeonbox/frontend(与 server 同版本) · ghcr.io/pigeonbox/p2p。 (fnos 2026-10-09 起只发原生 fpk,ghcr.io/pigeonbox/fnos 镜像已停发、冻结在 v1.14.6。) 桌面安装包(desktop-v*)与 NAS 应用包(fnos-v*/openwrt-v*/synology-v*/qnap-v*/ugreen-v*/terramaster-v*)统一回挂本仓 Releases;回挂与镜像齐后自动出 hub v<x.y.z> Latest 生态快照。写凭据统一为 org 级 secret PB_BOT_TOKEN(配置见 docs/release-bot-setup.md)。

产品文档

产品功能 / 使用说明 / API 对接等文档在本仓维护,不再回看 legacy 分支:

  • 文档站(推荐入口):docs-site/ —— 本地 cd docs-site && npm install && npm run docs:dev 即可浏览(快速开始 / 部署 / 环境变量 / 错误码 / 架构)。
  • 仓库内关键文档:
  • 历史产品 README(拆分前单体叙事)仍留在 legacy 分支 仅供考古。

License

Apache-2.0

About

FilesCodeBox 文件快递柜 — 匿名口令分享文本与文件的开源自托管平台(Go + Vue3)。生态装配仓:make setup 一键拉齐全部模块。Self-hosted anonymous passcode file sharing.

Topics

Resources

Contributing

Security policy

Stars

12 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages