lanol/filecodebox

文件快递柜-轻量（FileCodeBox-Lite）

***口令分享文本与文件，像拿快递一样取文件

主要特色

轻量简洁

基于 Fastapi+Sqlite3+Vue2+ElementUI 开发，架构轻量，无需复杂依赖，部署简单。

上传便捷

支持复制粘贴文本、拖拽选择文件两种上传方式，操作直观。

多类型支持

可分享文本内容或各类文件（如文档、图片等），满足不同场景需求。

安全防护

• 错误次数限制：防止***爆破取件码
• IP 限制上传次数：避免滥用资源

灵活分享

• 随机口令生成，支持自定义提取次数或有效期
• 全程***：无需注册账号，直接使用

管理功能

内置管理面板，可查看所有文件、手动删除内容，方便维护。

部署与存储

• Docker 一键部署，支持 AMD/ARM 架构
• 存储方式可选：本地文件流或阿里云 OSS

部署指南

Docker 一键部署

AMD 架构

bash
docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox docker.xuanyuan.run/lanol/filecodebox:latest

ARM 架构

bash
docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox docker.xuanyuan.run/lanol/filecodebox:arm

更新方式

bash
# 停止并删除现有容器
docker stop filecodebox && docker rm filecodebox  
# 重新拉取镜像并启动
docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox docker.xuanyuan.run/lanol/filecodebox:latest

1.6 版本注意事项

• 若升级后出现问题，可尝试清空 /opt/FileCodeBox 目录
• 首次安装后，需通过日志获取初始密码和后台地址：

  bash
  docker logs filecodebox
  

• 后台本地文件列表需手动迁移：将服务器文件移动至 /opt/FileCodeBox/data/locals 目录

项目说明

项目灵感源于“丁丁快传”，定位为轻量、单用户、离线环境（私有化）的文件快传系统。核心功能已完成，后续以维护现有功能、修复问题为主，不再新增大型功能。

配置说明

如需自定义配置，在 /opt/FileCodeBox/ 目录下创建 .env 文件（非 Docker 部署需在项目同目录 data 文件夹下创建），修改后重启容器即可。主要配置项如下：

dotenv
# 服务端口（默认 12345）
PORT=12345  
# 数据库路径
DATABASE_URL=sqlite+aiosqlite:///database.db  
# 存储引擎（filesystem 本地存储 / oss 阿里云OSS）
STORAGE_ENGINE=filesystem  
# 文件大小限制（单位 MB，默认 10）
FILE_SIZE_LIMIT=10  
# 管理后台路径（默认 admin）
ADMIN_ADDRESS=admin  
# 管理密码（默认 admin，首次启动后建议修改）
ADMIN_PASSWORD=admin  

# 阿里云 OSS 配置（使用时需补充）
KeyId=阿里云AccessKey  
KeySecret=阿里云AccessKeySecret  
OSS_ENDPOINT=地域节点（如 oss-cn-beijing.aliyuncs.com）  
BUCKET_NAME=Bucket名称  

接口参考

支持通过接口二次开发，核心接口如下：

取件接口

• 路径：/
• 方法：POST
• 参数：code（取件码）
• 响应示例：

  json
  {
    "detail": "操作成功",
    "data": {
      "type": "file",  // 类型：file 或 text
      "name": "文档.pdf",  // 文件名
      "code": "ABC123"  // 取件码
    }
  }
  

寄件接口

• 路径：/share
• 方法：POST
• 参数：
  • style：1（按提取次数）/ 2（按有效期）
  • value：次数（如 3）或分钟数（如 60）
  • text：文本内容（文本分享时必填）
  • file：文件（文件分享时必填）
• 响应示例：

  json
  {
    "detail": "分享成功",
    "data": {
      "code": "ABC123",  // 取件码
      "name": "文档.pdf"  // 文件名
    }
  }
  

常见问题

• 413 Request Entity Too Large：Nginx 限制上传大小，需修改 nginx.conf，在 http{} 中添加 client_max_body_size 10m;（根据需求调整大小），重启 Nginx 即可。

免责声明

本项目开源仅供学习使用，严禁用于任何违法用途，使用者需自行承担相关责任。使用时请保留项目地址。