Skip to content

About

内网文件传输工具

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

见山

简体中文 | English

见山是一个面向可信内网环境的轻量文件中转工具。用户可以通过浏览器上传文件,其他同事可以搜索、复制下载链接或直接下载。文件和元数据均保存在服务器本地磁盘,不依赖外部对象存储。

功能

  • 支持拖放、点击选择和多文件上传
  • 支持文件附言、搜索、分页、复制链接和下载
  • 文件列表默认每 5 秒静默刷新,不会整页闪烁
  • 文件默认保存 30 天,超期后自动删除索引和磁盘文件
  • 单页固定显示 5 个文件,超出后分页
  • 提供本机启动、停止和数据清理脚本
  • 支持 Docker Compose 部署

技术栈

  • React 18 + Vite
  • Node.js 20.6+
  • Express 5 + Multer
  • 本地 JSON 索引和文件系统存储

快速开始

开发模式

npm install
npm run dev

前端开发页面默认为 http://localhost:5173。Vite 和服务端都会监听局域网地址,同一内网的同事可通过服务器 IP 访问。

正式运行

推荐使用项目脚本:

./start.sh
./stop.sh

start.sh 会在需要时安装依赖、构建前端并在后台启动服务。默认访问地址为 http://服务器IP:3000,运行日志写入 service.log,进程号保存在 .file-share.pid。

也可以使用 npm 命令前台运行:

npm install
npm run build
npm start

Docker

docker compose up -d --build

停止服务:

docker compose down

Compose 会将项目中的 data/ 挂载到容器 /app/data,重新构建容器不会丢失文件。

配置

环境变量 默认值 说明
PORT 3000 服务端口
HOST 0.0.0.0 监听地址
STORAGE_DIR ./data 文件和元数据目录
MAX_FILE_SIZE_MB 1024 单个文件大小上限,单位 MB
MAX_FILES_PER_UPLOAD 10 每批最多上传文件数
FILE_RETENTION_DAYS 30 文件保存天数,超期自动删除
REFRESH_INTERVAL_SECONDS 5 浏览器文件列表静默刷新间隔,单位秒

可以在项目根目录创建 .env 文件供 start.sh 读取,例如:

PORT=3000
MAX_FILE_SIZE_MB=1024
MAX_FILES_PER_UPLOAD=10
FILE_RETENTION_DAYS=30
REFRESH_INTERVAL_SECONDS=5

数据目录

data/
|-- files.json    # 文件索引
\-- files/        # 上传的实际文件

data/ 已加入 .gitignore。部署迁移或备份时,需要同时保留 files.json 和 files/。达到保存期限的文件会自动删除,需要长期保留的内容请提前下载或备份。

清空运行数据

准备发布或开源前,可清空所有上传文件和元数据:

./clear-data.sh

脚本会显示目标目录、文件数量和占用空间。输入 DELETE 后才会执行,并自动停止由 start.sh 启动的本机服务。自动化环境可使用:

./clear-data.sh --yes

脚本会优先使用环境变量或 .env 中配置的 STORAGE_DIR,相对路径以项目根目录为基准。清理完成后会在该目录中保留空的 files.json 和 files/。此操作不可恢复。使用 Docker 时,请先运行 docker compose down。

项目结构

client/            # React 前端
server/            # Express API 和本地存储
test/              # Node.js 测试和浏览器端到端测试
start.sh           # 构建并启动服务
stop.sh            # 停止服务
clear-data.sh      # 清空运行数据
compose.yaml       # Docker Compose 配置
Dockerfile         # 容器镜像配置

检查

npm test
npm run build

浏览器端到端测试需要 Python 3,并需先安装 Playwright:

python3 -m pip install -r requirements-e2e.txt
python3 -m playwright install chromium
npm run test:e2e

端到端测试默认会自动启动一个使用临时数据目录的本地服务,并在结束后关闭。设置 E2E_BASE_URL 后,也可以针对自行管理的测试服务运行。

安全说明

  • 当前版本没有账号登录、权限隔离和访问审计,仅适用于可信公司内网。
  • 不要将服务直接暴露到公网。
  • 建议部署在具有固定内网 IP、稳定磁盘且不会自动休眠的电脑或 NAS 上。
  • 使用 Nginx 等反向代理时,需要同步调大请求体限制,例如 client_max_body_size。

许可证

本项目使用 MIT License。

About

内网文件传输工具

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages