zfile README

The project's README from github.com/zfile-dev/zfile. As one markdown file: README.md.

ZFile

ZFile 是面向个人和小团队的在线网盘程序,可统一管理多种存储,让文件浏览、预览和分享更简单。

最新版本 下载次数 最近提交 待处理问题 GitHub Stars GitCode Stars

官网 · 文档 · 在线演示

版本说明: ZFile 5.x 已发布,开源版与捐赠版已合并为同一版本。后续会剥离捐赠版代码,并将代码开源到本仓库。更新内容请查看 更新日志。

主要特性

快速开始

使用一键安装脚本:

curl -fsSL https://docs.zfile.vip/install.sh -o install.sh
chmod +x install.sh
./install.sh

更多安装方式请参考 安装文档。使用中遇到问题,可通过 GitHub Issues 反馈。

功能预览

文件列表

文件列表
画廊模式

画廊模式
视频预览

视频预览
音频预览

音频预览
文本预览

文本预览
PDF 预览

PDF 预览
Office 预览

Office 预览
3D 文件预览

3D 文件预览
生成直链

生成直链
页面设置

页面设置
查看后台管理截图(5 张)
后台登录

后台登录
存储源列表

存储源列表
添加本地存储

添加本地存储
用户管理

用户管理
显示设置

显示设置

开源许可

本项目基于 MIT License 开源。

支持作者

如果本项目对你有帮助,请作者喝杯咖啡吧。

赞助作者

Star History

Star History Chart

zfile (zfile-dev/zfile)

responsive
Searching Database…

10.9K ·GitHub
What is this?ZFile is a self-hosted web program that lets you manage multiple cloud and local storage sources (S3, OneDrive, SharePoint, Google Drive, FTP, SFTP, etc.) through one unified file browser, with online preview and sharing links.
Is this a desktop app or something I run on a server?It is a self-hosted web application (Spring Boot backend plus a Vue frontend) that you deploy on your own server, not an installed desktop or mobile app.
How do I get it running?You can use the official one-click install script, or deploy the Docker / Docker Compose image, which is built for both AMD64 and ARM64.
What does it need under the hood to run?The backend is Java/Spring Boot and needs a database - either MySQL or the bundled H2 - and Docker is the simplest way to get both pieces running together.
Does the free version have any limits?Download speed limiting and restricting which file types specific users can view or upload are only available in the donation version right now, though the plan is to eventually merge that code into the open-source release too.
What storage providers can ZFile manage?It can unify S3, OneDrive, SharePoint, Google Drive, Duoke Cloud, Upyun, local storage, FTP and SFTP, among other sources, in a single file browser.
What file types can be previewed online?Images, audio, video, text, PDF, Office documents, and even 3D OBJ files can be previewed directly in the browser.
Does it work well on mobile devices?Yes, the interface uses a responsive layout so the same UI adapts to phones, tablets, and desktop browsers.
Can multiple people use the same instance?Yes, ZFile supports multiple users and lets admins assign specific storage sources or directories to each one.
Creator
zfile-dev
Size
45.1 MB
Stars
10.9K
Age
7y
Commits · 90 Days