-
- 
-
- 
+ 
- 
+ 
+
+
+ 
Homepage • - Demo • - Discussion • - Documents • + Try it • + Discussion • + Documents • Download • - Telegram Group • - License + Telegram • + Discord
- -  ## :sparkles: Features -* :cloud: Support storing files into Local storage, Remote storage, Qiniu, Aliyun OSS, Tencent COS, Upyun, OneDrive, S3 compatible API. -* :outbox_tray: 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. -* :zap:Drag&Drop to upload files or folders, with streaming upload processing. -* :card_file_box: Drag & Drop to manage your files. -* :family_woman_girl_boy: Multi-users with multi-groups. -* :link: Create share links for files and folders with expiration date. -* :eye_speech_bubble: Preview videos, images, audios, ePub files online; edit texts, Office documents online. -* :art: Customize theme colors, dark mode, PWA application, SPA, i18n. -* :rocket: All-In-One packing, with all features out-of-the-box. -* 🌈 ... ... +- :cloud: Support storing files into Local, Remote node, OneDrive, S3 compatible API, Qiniu, Aliyun OSS, Tencent COS, Upyun, OneDrive. +- :outbox_tray: Upload/Download in directly transmission from client to storage providers. +- 💾 Integrate with Aria2/qBittorrent to download files in background, use multiple download nodes to share the load. +- 📚 Compress/Extract files, download files in batch. +- 💻 WebDAV support covering all storage providers. +- :zap:Drag&Drop to upload files or folders, with resumeable upload support. +- :card_file_box: Extract media metadata from files, search files by metadata or tags. +- :family_woman_girl_boy: Multi-users with multi-groups. +- :link: Create share links for files and folders with expiration date. +- :eye_speech_bubble: Preview videos, images, audios, ePub files online; edit texts, diagrams, Markdown, images, Office documents online. +- :art: Customize theme colors, dark mode, PWA application, SPA, i18n. +- :rocket: All-In-One packing, with all features out-of-the-box. +- 🌈 ... ... ## :hammer_and_wrench: Deploy -Download the main binary for your target machine OS, CPU architecture and run it directly. +To deploy Cloudreve, you can refer to [Getting started](https://docs.cloudreve.org/overview/quickstart) for a quick local deployment to test. -```shell -# 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](https://docs.cloudreve.org/v/en/getting-started/install) for a completed deployment. +When you're ready to deploy Cloudreve to a production environment, you can refer to [Deploy](https://docs.cloudreve.org/overview/deploy/) for a complete deployment. ## :gear: Build -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. +Please refer to [Build](https://docs.cloudreve.org/overview/build/) for how to build Cloudreve from source code. -#### Install goreleaser +## :rocket: Contributing -```shell -go install github.com/goreleaser/goreleaser@latest -``` - -#### Clone the code - -```shell -git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git -``` - -#### Compile - -```shell -goreleaser build --clean --single-target --snapshot -``` +If you're interested in contributing to Cloudreve, please refer to [Contributing](https://docs.cloudreve.org/api/contributing/) for how to contribute to Cloudreve. ## :alembic: Stacks -* [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) +- [Go](https://golang.org/) + [Gin](https://github.com/gin-gonic/gin) + [ent](https://github.com/ent/ent) +- [React](https://github.com/facebook/react) + [Redux](https://github.com/reduxjs/redux) + [Material-UI](https://github.com/mui-org/material-ui) ## :scroll: License diff --git a/README_zh-CN.md b/README_zh-CN.md index 2e91895..17b724a 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -11,93 +11,66 @@主页 • - 演示站 • - 讨论社区 • - 文档 • + 演示 • + 讨论 • + 文档 • 下载 • - Telegram 群组 • - 许可证 + Telegram • + Discord
-  ## :sparkles: 特性 -* :cloud: 支持本机、从机、七牛、阿里云 OSS、腾讯云 COS、又拍云、OneDrive (包括世纪互联版) 、S3兼容协议 作为存储端 -* :outbox_tray: 上传/下载 支持客户端直传，支持下载限速 -* 💾 可对接 Aria2 离线下载，可使用多个从机节点分担下载任务 -* 📚 在线 压缩/解压缩、多文件打包下载 -* 💻 覆盖全部存储策略的 WebDAV 协议支持 -* :zap: 拖拽上传、目录上传、流式上传处理 -* :card_file_box: 文件拖拽管理 -* :family_woman_girl_boy: 多用户、用户组、多存储策略 -* :link: 创建文件、目录的分享链接，可设定自动过期 -* :eye_speech_bubble: 视频、图像、音频、 ePub 在线预览，文本、Office 文档在线编辑 -* :art: 自定义配色、黑暗模式、PWA 应用、全站单页应用、国际化支持 -* :rocket: All-In-One 打包，开箱即用 -* 🌈 ... ... +- :cloud: 支持本机、从机、七牛、阿里云 OSS、腾讯云 COS、华为云 OBS、又拍云、OneDrive (包括世纪互联版) 、S3 兼容协议 作为存储端 +- :outbox_tray: 上传/下载 支持客户端直传，支持下载限速 +- 💾 可对接 Aria2 离线下载，可使用多个从机节点分担下载任务 +- 📚 在线 压缩/解压缩、多文件打包下载 +- 💻 覆盖全部存储策略的 WebDAV 协议支持 +- :zap: 拖拽上传、目录上传、分片上传 +- :card_file_box: 提取媒体元数据，通过元数据或标签搜索文件 +- :family_woman_girl_boy: 多用户、用户组、多存储策略 +- :link: 创建文件、目录的分享链接，可设定自动过期 +- :eye_speech_bubble: 视频、图像、音频、 ePub 在线预览，文本、Office 文档在线编辑 +- :art: 自定义配色、黑暗模式、PWA 应用、全站单页应用、国际化支持 +- :rocket: All-In-One 打包，开箱即用 +- 🌈 ... ... ## :hammer_and_wrench: 部署 -下载适用于您目标机器操作系统、CPU架构的主程序，直接运行即可。 +你可以参考 [快速开始](https://docs.cloudreve.org/overview/quickstart) 启动一个本地实例进行体验、测试。 -```shell -# 解压程序包 -tar -zxvf cloudreve_VERSION_OS_ARCH.tar.gz - -# 赋予执行权限 -chmod +x ./cloudreve - -# 启动 Cloudreve -./cloudreve -``` - -以上为最简单的部署示例，您可以参考 [文档 - 起步](https://docs.cloudreve.org/) 进行更为完善的部署。 +当你准备好将 Cloudreve 部署到生产环境时，可以参考 [部署](https://docs.cloudreve.org/overview/deploy/) 进行完整部署。 ## :gear: 构建 -自行构建前需要拥有 `Go >= 1.18`、`node.js`、`yarn`、`zip`, [goreleaser](https://goreleaser.com/intro/) 等必要依赖。 +你可以参考 [构建](https://docs.cloudreve.org/overview/build/) 从源代码构建 Cloudreve。 -#### 安装 goreleaser +## :rocket: 贡献 -```shell -go install github.com/goreleaser/goreleaser@latest -``` - -#### 克隆代码 - -```shell -git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git -``` - -#### 编译项目 - -```shell -goreleaser build --clean --single-target --snapshot -``` +如果你有兴趣为 Cloudreve 贡献代码，请参考 [贡献](https://docs.cloudreve.org/api/contributing/) 了解如何贡献。 ## :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) +- [Go](https://golang.org/) + [Gin](https://github.com/gin-gonic/gin) + [ent](https://github.com/ent/ent) +- [React](https://github.com/facebook/react) + [Redux](https://github.com/reduxjs/redux) + [Material-UI](https://github.com/mui-org/material-ui) ## :scroll: 许可证