github.com/cloudreve/Cloudreve/v3@v3.0.0-20240224133659-3edb00a6484c/README.md (about) 1 [中文版本](https://github.com/cloudreve/Cloudreve/blob/master/README_zh-CN.md) 2 3 <h1 align="center"> 4 <br> 5 <a href="https://cloudreve.org/" alt="logo" ><img src="https://raw.githubusercontent.com/cloudreve/frontend/master/public/static/img/logo192.png" width="150"/></a> 6 <br> 7 Cloudreve 8 <br> 9 </h1> 10 <h4 align="center">Self-hosted file management system with muilt-cloud support.</h4> 11 12 <p align="center"> 13 <a href="https://github.com/cloudreve/Cloudreve/actions/workflows/test.yml"> 14 <img src="https://img.shields.io/github/actions/workflow/status/cloudreve/Cloudreve/test.yml?branch=master&style=flat-square" 15 alt="GitHub Test Workflow"> 16 </a> 17 <a href="https://codecov.io/gh/cloudreve/Cloudreve"><img src="https://img.shields.io/codecov/c/github/cloudreve/Cloudreve?style=flat-square"></a> 18 <a href="https://goreportcard.com/report/github.com/cloudreve/Cloudreve"> 19 <img src="https://goreportcard.com/badge/github.com/cloudreve/Cloudreve?style=flat-square"> 20 </a> 21 <a href="https://github.com/cloudreve/Cloudreve/releases"> 22 <img src="https://img.shields.io/github/v/release/cloudreve/Cloudreve?include_prereleases&style=flat-square" /> 23 </a> 24 <a href="https://hub.docker.com/r/cloudreve/cloudreve"> 25 <img src="https://img.shields.io/docker/image-size/cloudreve/cloudreve?style=flat-square"/> 26 </a> 27 </p> 28 <p align="center"> 29 <a href="https://cloudreve.org">Homepage</a> • 30 <a href="https://demo.cloudreve.org">Demo</a> • 31 <a href="https://forum.cloudreve.org/">Discussion</a> • 32 <a href="https://docs.cloudreve.org/v/en/">Documents</a> • 33 <a href="https://github.com/cloudreve/Cloudreve/releases">Download</a> • 34 <a href="https://t.me/cloudreve_official">Telegram Group</a> • 35 <a href="#scroll-License">License</a> 36 </p> 37 38 39 40 ![Screenshot](https://raw.githubusercontent.com/cloudreve/docs/master/images/homepage.png) 41 42 ## :sparkles: Features 43 44 * :cloud: Support storing files into Local storage, Remote storage, Qiniu, Aliyun OSS, Tencent COS, Upyun, OneDrive, S3 compatible API. 45 * :outbox_tray: Upload/Download in directly transmission with speed limiting support. 46 * 💾 Integrate with Aria2 to download files offline, use multiple download nodes to share the load. 47 * 📚 Compress/Extract files, download files in batch. 48 * 💻 WebDAV support covering all storage providers. 49 * :zap:Drag&Drop to upload files or folders, with streaming upload processing. 50 * :card_file_box: Drag & Drop to manage your files. 51 * :family_woman_girl_boy: Multi-users with multi-groups. 52 * :link: Create share links for files and folders with expiration date. 53 * :eye_speech_bubble: Preview videos, images, audios, ePub files online; edit texts, Office documents online. 54 * :art: Customize theme colors, dark mode, PWA application, SPA, i18n. 55 * :rocket: All-In-One packing, with all features out-of-the-box. 56 * 🌈 ... ... 57 58 ## :hammer_and_wrench: Deploy 59 60 Download the main binary for your target machine OS, CPU architecture and run it directly. 61 62 ```shell 63 # Extract Cloudreve binary 64 tar -zxvf cloudreve_VERSION_OS_ARCH.tar.gz 65 66 # Grant execute permission 67 chmod +x ./cloudreve 68 69 # Start Cloudreve 70 ./cloudreve 71 ``` 72 73 The above is a minimum deploy example, you can refer to [Getting started](https://docs.cloudreve.org/v/en/getting-started/install) for a completed deployment. 74 75 ## :gear: Build 76 77 You need to have `Go >= 1.18`, `node.js`, `yarn`, `zip`, [goreleaser](https://goreleaser.com/intro/) and other necessary dependencies before you can build it yourself. 78 79 #### Install goreleaser 80 81 ```shell 82 go install github.com/goreleaser/goreleaser@latest 83 ``` 84 85 #### Clone the code 86 87 ```shell 88 git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git 89 ``` 90 91 #### Compile 92 93 ```shell 94 goreleaser build --clean --single-target --snapshot 95 ``` 96 97 ## :alembic: Stacks 98 99 * [Go](https://golang.org/) + [Gin](https://github.com/gin-gonic/gin) 100 * [React](https://github.com/facebook/react) + [Redux](https://github.com/reduxjs/redux) + [Material-UI](https://github.com/mui-org/material-ui) 101 102 ## :scroll: License 103 104 GPL V3