Go to file
Aaron Liu fe309b234c chore: add new build target: freebsd_amd64, freebsd_arm64, linux_loong64 (#2442) 2025-06-05 16:36:33 +08:00
.build Init V4 community edition (#2265) 2025-04-20 17:31:25 +08:00
.github Init V4 community edition (#2265) 2025-04-20 17:31:25 +08:00
application fix(session): kv is not initialized 2025-05-23 20:01:10 +08:00
assets@9bed9730aa chore: add new build target: freebsd_amd64, freebsd_arm64, linux_loong64 (#2442) 2025-06-05 16:36:33 +08:00
cmd Init V4 community edition (#2265) 2025-04-20 17:31:25 +08:00
ent feat(explorer): save user's view setting to server / optionally share view setting via share link (#2232) 2025-06-05 10:00:37 +08:00
inventory feat(explorer): save user's view setting to server / optionally share view setting via share link (#2232) 2025-06-05 10:00:37 +08:00
middleware Init V4 community edition (#2265) 2025-04-20 17:31:25 +08:00
pkg feat(explorer): save user's view setting to server / optionally share view setting via share link (#2232) 2025-06-05 10:00:37 +08:00
routers feat(explorer): save user's view setting to server / optionally share view setting via share link (#2232) 2025-06-05 10:00:37 +08:00
service feat(explorer): save user's view setting to server / optionally share view setting via share link (#2232) 2025-06-05 10:00:37 +08:00
.gitignore Init V4 community edition (#2265) 2025-04-20 17:31:25 +08:00
.gitmodules Modify: use public URL for asserts module 2020-03-12 12:07:07 +08:00
.goreleaser.yaml chore: add new build target: freebsd_amd64, freebsd_arm64, linux_loong64 (#2442) 2025-06-05 16:36:33 +08:00
Dockerfile chore(dockerfile): fix syntax error 2025-05-23 19:00:59 +08:00
LICENSE Add: README & License 2020-03-12 19:20:40 +08:00
README.md Update README.md 2024-10-25 13:31:21 +08:00
README_zh-CN.md chore: update readme and archive config 2023-02-09 20:29:38 +08:00
SECURITY.md Update SECURITY.md 2025-05-08 17:03:23 +08:00
azure-pipelines.yml chore: update dockerhub service connection 2025-04-21 20:24:56 +08:00
docker-compose.yml feat: upgrade from community to pro / remove unused edges in storage policy 2025-04-24 15:25:40 +08:00
giscus.json Create giscus.json 2025-02-25 18:06:11 +08:00
go.mod chore: add new build target: freebsd_amd64, freebsd_arm64, linux_loong64 (#2442) 2025-06-05 16:36:33 +08:00
go.sum chore: add new build target: freebsd_amd64, freebsd_arm64, linux_loong64 (#2442) 2025-06-05 16:36:33 +08:00
main.go Init V4 community edition (#2265) 2025-04-20 17:31:25 +08:00

README.md

中文版本V4 版本前瞻



Cloudreve

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

GitHub Test Workflow

HomepageDemoDiscussionDocumentsDownloadTelegram GroupLicense

Screenshot

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, zip, goreleaser and other necessary dependencies before you can build it yourself.

Install goreleaser

go install github.com/goreleaser/goreleaser@latest

Clone the code

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

Compile

goreleaser build --clean --single-target --snapshot

⚗️ Stacks

📜 License

GPL V3