Diagrams是一个云系统架构原型图制作库,它的诞生是为了在没有任何设计工具的情况下对新的系统架构进行原型设计。您还可以描述或可视化现有系统架构,Diagram as Code允许您跟踪任何版本控制系统中的架构图更改。相比于在 UI 上面对各种图标进行拖拽和调整,这种方式更符合我们程序员的使用习惯。
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.
Go to file
Aaron Liu 7dfe8fb439
chore: fix env in task yaml and test new build action
1 year ago
.github chore: fix env in task yaml and test new build action 1 year ago
assets@d4dc124e99 chore: fix env in task yaml and test new build action 1 year ago
bootstrap feat(wopi): change doc preview config based on WOPI discovery results 2 years ago
middleware test(wopi): add tests for wopi client 1 year ago
models refactor(db): move dialects to a standalone pkg 1 year ago
pkg refactor(db): change SQLite driver from github.com/jinzhu/gorm/dialects/sqlite to github.com/glebarez/go-sqlite (#1626) 1 year ago
routers feat(webdav): add read-only option (#1629) 1 year ago
service feat(explorer): advance delete options for users 1 year ago
.gitignore fix: zip assets folder path error 2 years ago
.gitmodules Modify: use public URL for asserts module 4 years ago
.travis.yml feat(static): release static files into memory while startup (#1471) 2 years ago
Dockerfile chore(build): add go-task support (#1608) 1 year ago
LICENSE Add: README & License 4 years ago
README.md chore(build): add go-task support (#1608) 1 year ago
README_zh-CN.md chore(build): add go-task support (#1608) 1 year ago
Taskfile.yaml chore: fix env in task yaml and test new build action 1 year ago
assets.zip fix(static): add placeholder empty zip file for go embed 2 years ago
build.sh fix: timeout while fetching yarn pkgs in building docker image action 2 years ago
docker-compose.yml feat: docker/docker-compose support (#1203) 2 years ago
go.mod refactor(db): change SQLite driver from github.com/jinzhu/gorm/dialects/sqlite to github.com/glebarez/go-sqlite (#1626) 1 year ago
go.sum refactor(db): change SQLite driver from github.com/jinzhu/gorm/dialects/sqlite to github.com/glebarez/go-sqlite (#1626) 1 year ago
main.go enhance: escalate `ProxyHeader` as a global config 2 years ago

README.md

中文版本



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, texts, Office documents, ePub files 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

📜 License

GPL V3