中文版本

Cloudreve

Self-hosted file management system with muilt-cloud support.

Homepage • Demo • Discussion • Documents • Download • Telegram Group • License

✨ Features

• ☁️ Support storing files into Local storage, Remote storage, Qiniu, Aliyun OSS, Tencent COS, Upyun, OneDrive, S3 compatible API.
• 📤 Upload/Download in directly transmission with speed limiting support.
• 💾 Integrate with Aria2 to download files offline, use multiple download nodes to share the load.
• 📚 Compress/Extract files, download files in batch.
• 💻 WebDAV support covering all storage providers.
• ⚡Drag&Drop to upload files or folders, with streaming upload processing.
• 🗃️ Drag & Drop to manage your files.
• 👩‍👧‍👦 Multi-users with multi-groups.
• 🔗 Create share links for files and folders with expiration date.
• 👁️‍🗨️ Preview videos, images, audios, ePub files online; edit texts, Office documents online.
• 🎨 Customize theme colors, dark mode, PWA application, SPA, i18n.
• 🚀 All-In-One packing, with all features out-of-the-box.
• 🌈 ... ...

🛠️ Deploy

Download the main binary for your target machine OS, CPU architecture and run it directly.

# Extract Cloudreve binary
tar -zxvf cloudreve_VERSION_OS_ARCH.tar.gz

# Grant execute permission
chmod +x ./cloudreve

# Start Cloudreve
./cloudreve

The above is a minimum deploy example, you can refer to Getting started for a completed deployment.

⚙️ Build

You need to have Go >= 1.18, node.js, yarn, curl, zip, go-task and other necessary dependencies before you can build it yourself.

Install go-task

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

For more installation methods, please refer to the official documentation: https://taskfile.dev/installation/

Clone the code

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

Compile

# Enter the project directory
cd Cloudreve

# Execute the task command
# Note: The `task` command executes the task named `default` by default.
task

# View compiled files
ls release

If you want to compile only the frontend code, please execute task build-frontend; similarly you can also execute task build-backend to only compile the backend code.

You can view all supported tasks through the task --list command:

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

⚗️ Stacks

• Go + Gin
• React + Redux + Material-UI

📜 License

GPL V3