f0rc3/gokapi

Gokapi 镜像文档

镜像概述和主要用途

Gokapi 是一个轻量级自托管的文件分享服务，作为 Firefox Send 的替代方案设计。它专注于提供私密、可控的文件分享体验，不支持公开上传功能，仅允许授权用户进行文件上传和管理。该服务无需数据库，以单文件形式运行，适合个人用户或小型团队在私有环境中部署，实现安全的文件传输与分享。

核心功能和特性

• 轻量级架构：无需数据库依赖，单可执行文件运行，资源占用低，部署简单
• 自托管部署：完全掌控数据存储与访问权限，避免依赖第三方公共服务
• 私密分享机制：无公开上传入口，仅授权管理员账户可执行文件上传操作
• 文件生命周期管理：支持自定义文件过期时间、最大下载次数限制
• 安全增强功能：可对分享文件设置密码保护，防止未授权访问
• 跨平台兼容性：支持 Linux、Windows、macOS 等系统，Docker 部署简化环境配置
• 简洁管理界面：通过网页端完成文件上传、分享参数配置和权限管理

使用场景和适用范围

• 个人用户需要安全分享敏感文件，不愿使用公共文件分享服务的场景
• 小型团队内部私密文件传输，确保数据不经过第三方服务器
• 临时文件分享需求，需设置自动过期机制以减少存储资源占用
• 对数据隐私有严格要求的组织，需完全控制文件存储与访问链路

详细使用方法和配置说明

基本部署（Docker Run 命令）

通过以下命令快速部署 Gokapi 容器：

bash
docker run -d \
  --name gokapi \
  -p 53842:53842 \
  -v /path/to/host/data:/app/data \
  -e GOKAPI_USER=admin \
  -e GOKAPI_PASSWORD=your_secure_password \
  forceu/gokapi

说明：

• -p 53842:53842：映射容器默认端口到主机
• -v /path/to/host/data:/app/data：持久化存储数据（配置文件和上传文件）
• -e GOKAPI_USER 和 -e GOKAPI_PASSWORD：设置管理员账户（首次启动必需）

Docker Compose 配置示例

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  gokapi:
    image: forceu/gokapi
    container_name: gokapi
    ports:
      - "53842:53842"
    volumes:
      - ./gokapi_data:/app/data  # 本地数据目录
    environment:
      - GOKAPI_USER=admin        # 管理员用户名
      - GOKAPI_PASSWORD=SecurePass123!  # 管理员密码
      - TZ=Asia/Shanghai         # 设置时区（可选）
      - LOG_LEVEL=info           # 日志级别（debug/info/warn/error）
    restart: unless-stopped

启动服务：docker-compose up -d

环境变量配置说明

初始使用流程

1. 部署完成后，访问 http://<主机IP>:53842 进入管理界面
2. 使用配置的管理员账户登录
3. 点击"Upload File"上传文件，配置分享参数：
   • 过期时间（如 7 天）
   • 最大下载次数（如 5 次）
   • 可选密码保护
4. 生成分享链接并发送给接收方
5. 接收方通过链接下载文件（需密码时输入密码）

高级配置

配置文件位于数据目录下的 config.json，主要可配置参数：

• maxFileSize: 最大上传文件大小（默认 2GB）
• defaultExpiryDays: 默认过期天数（未指定时生效）
• defaultMaxDownloads: 默认最大下载次数
• allowedIps: 限制上传IP（格式：["192.168.1.0/24", "10.0.0.1"]）

注意事项

• 首次启动必须配置 GOKAPI_USER 和 GOKAPI_PASSWORD，否则服务无法初始化
• 数据目录需持久化挂载，避免容器重建导致文件和配置丢失
• 建议通过反向代理（如 Nginx）配置 HTTPS，增强传输安全性
• 定期备份数据目录，防止文件意外丢失