mirror of
https://github.com/zfile-dev/zfile.git
synced 2025-04-19 05:34:52 +00:00
Update README.md
This commit is contained in:
赵俊
110
README.md
110
README.md
@@ -1,7 +1,7 @@
|
||||
<p align = "center">
|
||||
<img alt="ZFile" src="https://cdn.jun6.net/2021/04/21/69a89344e2a84.png" height="150px">
|
||||
<br><br>
|
||||
基于 Java 的在线网盘程序，支持对接 S3、OneDrive、SharePoint、又拍云、本地存储、FTP 等存储源，支持在线浏览图片、播放音视频，文本文件等文件类型。
|
||||
基于 Java 的在线网盘程序，支持对接 S3、OneDrive、SharePoint、又拍云、本地存储、FTP、SFTP 等存储源，支持在线浏览图片、播放音视频，文本文件等文件类型。
|
||||
<br><br>
|
||||
<img src="https://img.shields.io/badge/license-MIT-blue.svg?longCache=true&style=flat-square">
|
||||
<img src="https://api.codacy.com/project/badge/Grade/70b793267f7941d58cbd93f50c9a8e0a">
|
||||
@@ -31,25 +31,36 @@
|
||||
|
||||
## 系统特色
|
||||
|
||||
* 文件夹密码
|
||||
* 目录 README 说明
|
||||
* 文件直链（短链，永久直链，二维码）
|
||||
* 支持在线浏览文本文件, 视频, 图片, 音乐. (支持 FLV 和 HLS)
|
||||
* 图片模式
|
||||
* 支持文件操作：上传, 删除, 重命名, 新建文件夹. 后续还会支持移动和复制文件（详见下方**后续计划**）.
|
||||
* 操作系统级的文件操作体验
|
||||
1. 支持拖拽上传和 Ctrl + V 粘贴上传文件和文件夹
|
||||
2. 支持 Ctrl + A 全选文件, 按 Esc 取消全选.
|
||||
3. 支持拖拽批量选择文件
|
||||
4. 支持按住 Shift 多选文件
|
||||
5. 支持多选文件后按 Delete 键删除文件.
|
||||
6. 按 Backspace 返回上级文件夹.
|
||||
* 全新的 UI 风格, 更简洁易用.
|
||||
* 支持给文件生成直链（短链，永久直链，二维码）
|
||||
* 视频播放器支持调用本地软件进行下载，如迅雷、Motrix. 支持调用本地播放器播放，更好的进行视频解码： PotPlayer， IINA, VLC, nPlayer, MXPlayer(Free/Pro)
|
||||
* 全新画廊模式, 支持按照瀑布流显示图片, 支持自定义 N 栏, 自定义每栏的间距
|
||||
* 支持给文件夹配置 markdown 文档, 并配置显示方式, 如顶部、底部、弹窗
|
||||
* 支持给文件夹设置密码
|
||||
* 支持隐藏文件或文件夹
|
||||
* 后台登录支持设置图片验证码和 2FA 身份认证，防止后台被暴力破解
|
||||
* 支持自定义文件格式后缀, 避免系统内置的不完善导致文件无法预览.
|
||||
* Docker 支持
|
||||
* 隐藏指定文件夹（通配符支持）
|
||||
* 自定义 JS, CSS
|
||||
* 自定义目录 README 说明文件和密码文件名称
|
||||
* 同时挂载多个存储策略
|
||||
* 缓存动态开启, ~~缓存自动刷新 (v2.2 及以前版本支持)~~
|
||||
* ~~全局搜索 (v2.2 及以前版本支持)~~
|
||||
* 支持 S3 协议, 阿里云 OSS, FTP, 华为云 OBS, 本地存储, MINIO, OneDrive 国际/家庭/个人版/世纪互联版/SharePoint, , 七牛云 KODO, 腾讯云 COS, 又拍云 USS.
|
||||
* 支持 S3 协议, 阿里云 OSS, FTP, SFTP, 华为云 OBS, 本地存储, MINIO, OneDrive 国际/家庭/个人版/世纪互联版/SharePoint, , 七牛云 KODO, 腾讯云 COS, 又拍云 USS.
|
||||
|
||||
## 快速开始
|
||||
|
||||
<details>
|
||||
<summary>普通安装 (点击展开)</summary>
|
||||
安装依赖环境:
|
||||
|
||||
```bash
|
||||
|
||||
# CentOS系统
|
||||
yum install -y java-1.8.0-openjdk unzip
|
||||
```
|
||||
@@ -69,8 +80,6 @@ apt update && apt install -y adoptopenjdk-8-hotspot-jre
|
||||
```
|
||||
|
||||
|
||||
> 如为更新程序, 则请先执行 `~/zfile/bin/stop.sh && rm -rf ~/zfile` 清理旧程序. 首次安装请忽略此选项.
|
||||
|
||||
下载项目:
|
||||
|
||||
```bash
|
||||
@@ -81,44 +90,65 @@ unzip zfile-release.war && rm -rf zfile-release.war
|
||||
chmod +x $ZFILE_INSTALL_PATH/bin/*.sh
|
||||
```
|
||||
|
||||
> 下载指定版本可以将 `zfile-release.war` 改为 `zfile-x.x.war`，如 `zfile-2.2.war`。
|
||||
|
||||
程序的目录结构为:
|
||||
```
|
||||
├── zfile
|
||||
├── META-INF
|
||||
├── WEB-INF
|
||||
└── bin
|
||||
├── start.sh # 启动脚本
|
||||
└── stop.sh # 停止脚本
|
||||
├── restart.sh # 重启脚本
|
||||
```
|
||||
|
||||
启动项目:
|
||||
|
||||
```bash
|
||||
~/zfile/bin/start.sh
|
||||
```
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
<details>
|
||||
<summary>Docker (点击展开)</summary>
|
||||
|
||||
```
|
||||
docker run -d --name=zfile --restart=always \
|
||||
-p 8080:8080 \
|
||||
-v /root/zfile/db:/root/.zfile-v4/db \
|
||||
-v /root/zfile/logs:/root/.zfile-v4/logs \
|
||||
zhaojun1998/zfile
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
<details>
|
||||
<summary>Docker Compose (点击展开)</summary>
|
||||
|
||||
```yml
|
||||
version: '3.3'
|
||||
services:
|
||||
zfile:
|
||||
container_name: zfile
|
||||
restart: always
|
||||
ports:
|
||||
- '8080:8080'
|
||||
volumes:
|
||||
- '/root/zfile/db:/root/.zfile-v4/db'
|
||||
- '/root/zfile/logs:/root/.zfile-v4/logs'
|
||||
image: zhaojun1998/zfile
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
篇幅有限, 更详细的安装教程及介绍请参考: [ZFile 文档](https://docs.zfile.vip)
|
||||
|
||||
访问地址:
|
||||
|
||||
用户前台: http://127.0.0.1:8080/main
|
||||
|
||||
初始安装: http://127.0.0.1:8080/install
|
||||
|
||||
管理后台: http://127.0.0.1:8080/admin
|
||||
|
||||
|
||||
## 预览
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user