You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
cloudreve/README_zh-CN.md

6.2 KiB

English Version



Cloudreve

支持多家云存储驱动的公有云文件系统.

GitHub Test Workflow

主页演示站讨论社区文档下载Telegram 群组许可证

Screenshot

特性

  • ☁️ 支持本机、从机、七牛、阿里云 OSS、腾讯云 COS、又拍云、OneDrive (包括世纪互联版) 、S3兼容协议 作为存储端
  • 📤 上传/下载 支持客户端直传,支持下载限速
  • 💾 可对接 Aria2 离线下载,可使用多个从机节点分担下载任务
  • 📚 在线 压缩/解压缩、多文件打包下载
  • 💻 覆盖全部存储策略的 WebDAV 协议支持
  • 拖拽上传、目录上传、流式上传处理
  • 🗃️ 文件拖拽管理
  • 👩‍👧‍👦 多用户、用户组、多存储策略
  • 🔗 创建文件、目录的分享链接,可设定自动过期
  • 👁️‍🗨️ 视频、图像、音频、文本、Office 文档、 ePub 在线预览
  • 🎨 自定义配色、黑暗模式、PWA 应用、全站单页应用、国际化支持
  • 🚀 All-In-One 打包,开箱即用
  • 🌈 ... ...

🛠️ 部署

下载适用于您目标机器操作系统、CPU架构的主程序直接运行即可。

# 解压程序包
tar -zxvf cloudreve_VERSION_OS_ARCH.tar.gz

# 赋予执行权限
chmod +x ./cloudreve

# 启动 Cloudreve
./cloudreve

以上为最简单的部署示例,您可以参考 文档 - 起步 进行更为完善的部署。

⚙️ 构建

自行构建前需要拥有 Go >= 1.18node.jsyarncurlzipgo-task 等必要依赖。

安装 go-task

sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin

对于其他平台或者其他安装方式, 请参考官方安装文档: https://taskfile.dev/installation/

克隆代码

git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git

编译项目

# 进入项目目录
cd Cloudreve

# 执行 task 命令
# 提示: 单独执行 `task` 命令实际上默认执行叫做 `default` 的 task
task

# 查看已编译好的文件
ls release

如果你期望单独编译前端代码, 请执行 task build-frontend 命令; 同样你可以通过执行 task build-backend 命令单独编译后端代码.

你可以通过执行 task --list 命令查看所以已支持的 task.

~/Cloudreve  task --list                                                                                                                                          ✘ 146 master ✱
task: Available tasks for this project:
* all:                  Build All Platform
* build:                Build Cloudreve
* build-backend:        Build Backend
* build-frontend:       Build Frontend
* clean:                Clean All Build Cache
* clean-backend:        Clean Backend Build Cache
* clean-frontend:       Clean Frontend Build Cache
* darwin-amd64:         Build Backend(darwin-amd64)
* darwin-amd64-v2:      Build Backend(darwin-amd64-v2)
* darwin-amd64-v3:      Build Backend(darwin-amd64-v3)
* darwin-amd64-v4:      Build Backend(darwin-amd64-v4)
* darwin-arm64:         Build Backend(darwin-arm64)
* freebsd-386:          Build Backend(freebsd-386)
* freebsd-amd64:        Build Backend(freebsd-amd64)
* freebsd-amd64-v2:     Build Backend(freebsd-amd64-v2)
* freebsd-amd64-v3:     Build Backend(freebsd-amd64-v3)
* freebsd-amd64-v4:     Build Backend(freebsd-amd64-v4)
* freebsd-arm:          Build Backend(freebsd-arm)
* freebsd-arm64:        Build Backend(freebsd-arm64)
* linux-amd64:          Build Backend(linux-amd64)
* linux-amd64-v2:       Build Backend(linux-amd64-v2)
* linux-amd64-v3:       Build Backend(linux-amd64-v3)
* linux-amd64-v4:       Build Backend(linux-amd64-v4)
* linux-armv5:          Build Backend(linux-armv5)
* linux-armv6:          Build Backend(linux-armv6)
* linux-armv7:          Build Backend(linux-armv7)
* linux-armv8:          Build Backend(linux-armv8)
* windows-amd64:        Build Backend(windows-amd64)
* windows-amd64-v2:     Build Backend(windows-amd64-v2)
* windows-amd64-v3:     Build Backend(windows-amd64-v3)
* windows-amd64-v4:     Build Backend(windows-amd64-v4)
* windows-arm64:        Build Backend(windows-arm64)

⚗️ 技术栈

📜 许可证

GPL V3