diff --git a/README.md b/README.md index d23c9ec..bbd4733 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[中文版本](https://github.com/cloudreve/Cloudreve/blob/master/README.md) +


@@ -5,12 +7,11 @@ Cloudreve

- -

支持多家云存储驱动的公有云文件系统.

+

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

- GitHub Test Workflow @@ -24,108 +25,106 @@

-

- 演示站 • - 讨论社区 • - 文档 • - 下载 • - Telegram 群组 • - 许可证 + Homepage • + Demo • + Discussion • + Documents • + Download • + Telegram Group • + License

+ + ![Screenshot](https://raw.githubusercontent.com/cloudreve/docs/master/images/homepage.png) -## :sparkles: 特性 - -* :cloud: 支持本机、从机、七牛、阿里云 OSS、腾讯云 COS、又拍云、OneDrive (包括世纪互联版) 作为存储端 -* :outbox_tray: 上传/下载 支持客户端直传，支持下载限速 -* 💾 可对接 Aria2 离线下载，可使用多个从机节点分担下载任务 -* 📚 在线 压缩/解压缩、多文件打包下载 -* 💻 覆盖全部存储策略的 WebDAV 协议支持 -* :zap: 拖拽上传、目录上传、流式上传处理 -* :card_file_box: 文件拖拽管理 -* :family_woman_girl_boy: 多用户、用户组 -* :link: 创建文件、目录的分享链接，可设定自动过期 -* :eye_speech_bubble: 视频、图像、音频、文本、Office 文档在线预览 -* :art: 自定义配色、黑暗模式、PWA 应用、全站单页应用 -* :rocket: All-In-One 打包，开箱即用 +## :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, texts, Office documents, ePub files 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: 部署 +## :hammer_and_wrench: Deploy -下载适用于您目标机器操作系统、CPU架构的主程序，直接运行即可。 +Download the main binary for your target machine OS, CPU architecture and run it directly. ```shell -# 解压程序包 +# Extract Cloudreve binary tar -zxvf cloudreve_VERSION_OS_ARCH.tar.gz -# 赋予执行权限 +# Grant execute permission chmod +x ./cloudreve -# 启动 Cloudreve +# Start Cloudreve ./cloudreve ``` -以上为最简单的部署示例，您可以参考 [文档 - 起步](https://docs.cloudreve.org/) 进行更为完善的部署。 +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. -## :gear: 构建 +## :gear: Build -自行构建前需要拥有 `Go >= 1.18`、`node.js`、`yarn`、`zip` 等必要依赖。 +You need to have `Go >= 1.18`, `node.js`, `yarn`, `zip` and other necessary dependencies before you can build it yourself. -#### 克隆代码 +#### Clone the code ```shell git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git ``` -#### 构建静态资源 +#### Build static resources ```shell -# 进入前端子模块 +# Enter frontend sub-module cd assets -# 安装依赖 +# Install dependencies yarn install -# 开始构建 +# Start building yarn run build -# 构建完成后删除映射文件 +# Delete unused map files cd build find . -name "*.map" -type f -delete -# 返回项目主目录打包静态资源 +# Return to main folder to pack static files cd ../../ zip -r - assets/build >assets.zip ``` -#### 编译项目 +#### Compile ```shell -# 获得当前版本号、Commit +# Obtain version number, commit SHA export COMMIT_SHA=$(git rev-parse --short HEAD) export VERSION=$(git describe --tags) -# 开始编译 +# Compile go build -a -o cloudreve -ldflags "-s -w -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'" ``` -你也可以使用项目根目录下的 `build.sh` 快速开始构建： +You can also start a quick build using `build.sh` in the project root directory: ```shell ./build.sh [-a] [-c] [-b] [-r] - a - 构建静态资源 - c - 编译二进制文件 - b - 构建前端 + 编译二进制文件 - r - 交叉编译，构建用于release的版本 + a - Build assets + c - Build binary backend + b - Build both assets and backend + r - Cross-compilation for final release ``` -## :alembic: 技术栈 +## :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) -## :scroll: 许可证 +## :scroll: License GPL V3 - ---- -> GitHub [@HFO4](https://github.com/HFO4)  ·  -> Twitter [@abslant00](https://twitter.com/abslant00) diff --git a/README_zh-CN.md b/README_zh-CN.md new file mode 100644 index 0000000..98a7247 --- /dev/null +++ b/README_zh-CN.md @@ -0,0 +1,130 @@ +[English Version](https://github.com/cloudreve/Cloudreve/blob/master/README_zh-CN.md) + +

+
+ +
+ Cloudreve +
+

+ +

支持多家云存储驱动的公有云文件系统.

+ +

+ + GitHub Test Workflow + + + + + + + + + + + +

+

+ 主页 • + 演示站 • + 讨论社区 • + 文档 • + 下载 • + Telegram 群组 • + 许可证 +

+ + +![Screenshot](https://raw.githubusercontent.com/cloudreve/docs/master/images/homepage.png) + +## :sparkles: 特性 + +* :cloud: 支持本机、从机、七牛、阿里云 OSS、腾讯云 COS、又拍云、OneDrive (包括世纪互联版) 、S3兼容协议 作为存储端 +* :outbox_tray: 上传/下载 支持客户端直传，支持下载限速 +* 💾 可对接 Aria2 离线下载，可使用多个从机节点分担下载任务 +* 📚 在线 压缩/解压缩、多文件打包下载 +* 💻 覆盖全部存储策略的 WebDAV 协议支持 +* :zap: 拖拽上传、目录上传、流式上传处理 +* :card_file_box: 文件拖拽管理 +* :family_woman_girl_boy: 多用户、用户组、多存储策略 +* :link: 创建文件、目录的分享链接，可设定自动过期 +* :eye_speech_bubble: 视频、图像、音频、文本、Office 文档、 ePub 在线预览 +* :art: 自定义配色、黑暗模式、PWA 应用、全站单页应用、国际化支持 +* :rocket: All-In-One 打包，开箱即用 +* 🌈 ... ... + +## :hammer_and_wrench: 部署 + +下载适用于您目标机器操作系统、CPU架构的主程序，直接运行即可。 + +```shell +# 解压程序包 +tar -zxvf cloudreve_VERSION_OS_ARCH.tar.gz + +# 赋予执行权限 +chmod +x ./cloudreve + +# 启动 Cloudreve +./cloudreve +``` + +以上为最简单的部署示例，您可以参考 [文档 - 起步](https://docs.cloudreve.org/) 进行更为完善的部署。 + +## :gear: 构建 + +自行构建前需要拥有 `Go >= 1.18`、`node.js`、`yarn`、`zip` 等必要依赖。 + +#### 克隆代码 + +```shell +git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git +``` + +#### 构建静态资源 + +```shell +# 进入前端子模块 +cd assets +# 安装依赖 +yarn install +# 开始构建 +yarn run build +# 构建完成后删除映射文件 +cd build +find . -name "*.map" -type f -delete +# 返回项目主目录打包静态资源 +cd ../../ +zip -r - assets/build >assets.zip +``` + +#### 编译项目 + +```shell +# 获得当前版本号、Commit +export COMMIT_SHA=$(git rev-parse --short HEAD) +export VERSION=$(git describe --tags) + +# 开始编译 +go build -a -o cloudreve -ldflags "-s -w -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'" +``` + +你也可以使用项目根目录下的 `build.sh` 快速开始构建： + +```shell +./build.sh [-a] [-c] [-b] [-r] + a - 构建静态资源 + c - 编译二进制文件 + b - 构建前端 + 编译二进制文件 + r - 交叉编译，构建用于release的版本 +``` + +## :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) + +## :scroll: 许可证 + +GPL V3 diff --git a/assets b/assets index dca19d7..f0a1835 160000 --- a/assets +++ b/assets @@ -1 +1 @@ -Subproject commit dca19d76f62b2a50ff41c7439ac07f3529716557 +Subproject commit f0a1835ce198f0953c8b5f4ad45dba445b641164