[English Version](https://github.com/cloudreve/Cloudreve/blob/master/README.md)

<h1 align="center">
  <br>
  <a href="https://cloudreve.org/" alt="logo" ><img src="https://raw.githubusercontent.com/cloudreve/frontend/master/public/static/img/logo192.png" width="150"/></a>
  <br>
  Cloudreve
  <br>
</h1>

<h4 align="center">支持多家云存储驱动的公有云文件系统.</h4>

<p align="center">
  <a href="https://github.com/cloudreve/Cloudreve/actions/workflows/test.yml">
    <img src="https://img.shields.io/github/actions/workflow/status/cloudreve/Cloudreve/test.yml?branch=master&style=flat-square"
         alt="GitHub Test Workflow">
  </a>
  <a href="https://codecov.io/gh/cloudreve/Cloudreve"><img src="https://img.shields.io/codecov/c/github/cloudreve/Cloudreve?style=flat-square"></a>
  <a href="https://goreportcard.com/report/github.com/cloudreve/Cloudreve">
      <img src="https://goreportcard.com/badge/github.com/cloudreve/Cloudreve?style=flat-square">
  </a>
  <a href="https://github.com/cloudreve/Cloudreve/releases">
    <img src="https://img.shields.io/github/v/release/cloudreve/Cloudreve?include_prereleases&style=flat-square" />
  </a>
  <a href="https://hub.docker.com/r/cloudreve/cloudreve">
     <img src="https://img.shields.io/docker/image-size/cloudreve/cloudreve?style=flat-square"/>
  </a>
</p>
<p align="center">
  <a href="https://cloudreve.org">主页</a> •
  <a href="https://demo.cloudreve.org">演示站</a> •
  <a href="https://forum.cloudreve.org/">讨论社区</a> •
  <a href="https://docs.cloudreve.org/">文档</a> •
  <a href="https://github.com/cloudreve/Cloudreve/releases">下载</a> •
  <a href="https://t.me/cloudreve_official">Telegram 群组</a> •
  <a href="#scroll-许可证">许可证</a>
</p>


![Screenshot](https://raw.githubusercontent.com/cloudreve/docs/master/images/homepage.png)

## :sparkles: 特性

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

## :hammer_and_wrench: 部署

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

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

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

# 启动 Cloudreve
./cloudreve
```

以上为最简单的部署示例，您可以参考 [文档 - 起步](https://docs.cloudreve.org/) 进行更为完善的部署。

## :gear: 构建

自行构建前需要拥有 `Go >= 1.18`、`node.js`、`yarn`、`curl`、`zip`、`go-task` 等必要依赖。

#### 安装 go-task

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

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

#### 克隆代码

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

#### 编译项目

```shell
# 进入项目目录
cd Cloudreve

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

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

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

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

```shell
~/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)
```

## :alembic: 技术栈

* [Go](https://golang.org/) + [Gin](https://github.com/gin-gonic/gin)
* [React](https://github.com/facebook/react) + [Redux](https://github.com/reduxjs/redux) + [Material-UI](https://github.com/mui-org/material-ui)

## :scroll: 许可证

GPL V3