# file-ferry-system

**Repository Path**: ceagle/file-ferry-system

## Basic Information

- **Project Name**: file-ferry-system
- **Description**: 内外网文件交换系统，基于python
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-27
- **Last Updated**: 2026-03-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# File Ferry System - 文件摆渡系统

安全跨区域文件传输系统，支持内外网之间的安全文件交换。

## 特性

- 🔐 **安全传输** - 入网/出网双向文件传输
- 🦠 **病毒扫描** - 入网文件自动 ClamAV 扫描
- 📋 **审批流程** - 多级审批工作流
- 👥 **权限控制** - 基于角色的访问控制 (RBAC)
- 📝 **审计追踪** - 完整操作日志记录

## 快速开始

```bash
# 克隆仓库
git clone https://gitee.com/ceagle/file-ferry-system.git
cd file-ferry-system

# 配置环境变量
cp .env.example .env
# 编辑 .env 修改必要配置

# 启动服务
docker compose -f docker/docker-compose-infrastructure.yml up -d
docker compose -f docker/docker-compose-backend.yml up -d
docker compose -f docker/docker-compose-admin-frontend.yml up -d --build
```

详细部署步骤请参考 [QUICKSTART.md](./QUICKSTART.md)

## 项目结构

```
file-ferry-system/
├── app/                          # 后端应用 (Python/FastAPI)
├── frontend-admin/frontend/      # 管理后台前端 (Vue 3) ⭐ 主要前端
├── frontend-archive/             # 旧版前端归档 - 已废弃
├── docker/                       # Docker 配置
├── docs/                         # 文档
├── tests/                        # 测试代码
└── specs/                        # 功能规格
```

> **注意**: `frontend-archive/` 是旧前端的归档，已废弃。所有新功能使用 `frontend-admin/frontend/`

## 服务访问

| 服务 | 地址 | 说明 |
|------|------|------|
| 管理后台 | http://localhost:82 | 主要前端（推荐） |
| 旧版前端 | http://localhost:81 | 维护模式 |
| API 文档 | http://localhost:8000/docs | Swagger UI |
| 健康检查 | http://localhost:8000/health | 服务状态 |

## 技术栈

| 层级 | 技术 |
|------|------|
| 后端 | Python 3.11+, FastAPI, SQLAlchemy |
| 前端 | Vue 3.5+, TypeScript 5+, Element Plus |
| 数据库 | PostgreSQL 15 |
| 缓存 | Redis 7 |
| 病毒扫描 | ClamAV |
| 文件存储 | vsftpd |
| 容器编排 | Docker Compose |

## 文档

- [快速入门](./QUICKSTART.md)
- [系统架构](./docs/architecture.md)
- [配置指南](./docs/config-guide.md)
- [故障排查](./docs/troubleshooting.md)
- [用户指南](./docs/user-guide.md)

## 开发

```bash
# 安装后端依赖
pip install -r requirements.txt

# 安装前端依赖
cd frontend-admin/frontend && pnpm install

# 运行测试
pytest tests/ -v
```

## 许可证

MIT License