malaohu/cloudreve repository overview

⁠Cloudreve Docker

优势

• 基于最新的Cloudreve V3
• 长期维护
• 镜像体积小
• 纯净安装，无多余组件
• 支持多种架构
  • xaiverniu/cloudreve:latest for linux/amd64
  • xaiverniu/cloudreve:arm64v8 for linux/arm64
  • xaiverniu/cloudreve:arm32v7 for linux/arm/v7
• 简易安装
• 内含详细的Cloudreve+Caddy+Aria2部署教程

⁠Cloudreve

Cloudreve能助您以最低的成本快速搭建公私兼备的网盘系统。

官方网站：https://cloudreve.org⁠

GitHub：https://github.com/cloudreve/Cloudreve⁠

⁠开始

运行模式

• Docker Run方式运行
  • OC: 仅Cloudreve
  • CAC: Caddy反代+Aria2离线下载服务+Cloudreve
• Docker Compose方式运行
  • CAC: Caddy反代+Aria2离线下载服务+Cloudreve

⁠获取PUID和PGID

为什么要使用PUID和PGID参见: Understanding PUID and PGID⁠

假设当前登陆用户为root，则执行

id root

就会得到类似于下面的一段代码

uid=1000(root) gid=1001(root)

则PUID填入1000，PGID填入1001

⁠Docker Run方式运行

⁠OC

预创建Cloudreve的数据库和配置文件，这里以/dockercnf/cloudreve为cloudreve配置目录。

mkdir -p /dockercnf/cloudreve \
	&& touch /dockercnf/cloudreve/conf.ini \
	&& touch /dockercnf/cloudreve/cloudreve.db

启动容器

docker run -d \
  --name cloudreve \
  -e PUID=1000 \ # optional
  -e PGID=1000 \ # optional
  -e TZ="Asia/Shanghai" \ # optional
  -p 5212:5212 \ 
  --restart=unless-stopped \
  -v <PATH TO UPLOADS>:/cloudreve/uploads \
  -v <PATH TO conf.ini>:/cloudreve/conf.ini \
  -v <PATH TO cloudreve.db>:/cloudreve/cloudreve.db \
  xavierniu/cloudreve

说明

• 首次启动后请执行docker logs -f cloudreve获取初始密码
• PUID以及PGID的获取方式详见获取PUID和PGID
• TZ设置时区，默认值为Asia/Shanghai
• <PATH TO UPLOADS>:上传目录, 例如/sharedfolders
• <PATH TO conf.ini>: 配置文件，如/dockercnf/cloudreve/conf.ini（注意这里是挂载的文件，而非文件夹）
• <PATH TO cloudreve.db>: 数据库文件，如/dockercnf/cloudreve/cloudreve.db（注意这里是挂载的文件，而非文件夹）

⁠CAC

前提

• 已安装docker，如果没有请执行wget -qO- https://get.docker.com/ | bash安装docker。
• 一个域名并解析到运行Cloudreve的服务器，这里以cloudreve.example.com为例。

Step1. 创建Network

docker network create my-network

Step2. 创建Caddy配置文件

mkdir -p /dockercnf/caddy \
	&& vim /dockercnf/caddy/Caddyfile

填入以下信息

cloudreve.example.com {
  tls [email protected]
  proxy / cloudreve:5212 {
    transparent
  }
}

Step3. 启动Caddy服务

docker run -d \
  --name caddy \
  -e "ACME_AGREE=true" \
  -e "CADDYPATH=/etc/caddycerts" \
  -v /dockercnf/caddy/certs:/etc/caddycerts \
  -v /dockercnf/caddy/Caddyfile:/etc/Caddyfile \
  --network my-network \
  -p 80:80 -p 443:443 \
  --restart unless-stopped \
  abiosoft/caddy

Step4. 启动Aria2服务（如不需要离线下载功能该步骤略过）

docker run -d \
    --name aria2 \
    --restart unless-stopped \
    --log-opt max-size=1m \
    -e PUID=1000 \
    -e PGID=1000 \
    -e RPC_SECRET=<SECRET> \
    -p 6800:6800 \ #1
    -p 6888:6888 -p 6888:6888/udp \
    --network my-network \
    -v <PATH TO CONFIG>:/config \
    -v <PATH TO TEMP>:/downloads \
    p3terx/aria2-pro

说明

• PUID以及PGID的获取方式详见获取PUID和PGID。
• <SECRET>: Aria2 RPC密码（你可以去这里⁠生成随机字符串）。请记下该密码！在后续Cloudreve设置Aria2中会使用。
• <PATH TO CONFIG>: Aria2的配置文件夹，例如/dockercnf/aria2/conf。
• <PATH TO TEMP>: 临时下载文件夹，需要与Cloudreve的/downloads对应，例如/dockercnf/aria2/temp。
• 如果不需要外网访问Aria2可以将#1所在行删除。

Step5. 预创建Cloudreve的数据库和配置文件，这里以/dockercnf/cloudreve为cloudreve配置目录

mkdir -p /dockercnf/cloudreve \
	&& touch /dockercnf/cloudreve/conf.ini \
	&& touch /dockercnf/cloudreve/cloudreve.db

Step6. 启动Cloudreve

docker run -d \
  --name cloudreve \
  -e PUID=1000 \ # optional
  -e PGID=1000 \ # optional
  -e TZ="Asia/Shanghai" \ # optional
  --network my-network \
  --restart=unless-stopped \
  -v <PATH TO UPLOADS>:/cloudreve/uploads \
  -v <PATH TO TEMP>:/downloads \ #1
  -v <PATH TO conf.ini>:/cloudreve/conf.ini \
  -v <PATH TO cloudreve.db>:/cloudreve/cloudreve.db \
  xavierniu/cloudreve

说明

• 首次启动后请执行docker logs -f cloudreve获取初始密码

• PUID以及PGID的获取方式详见获取PUID和PGID

• <PATH TO UPLOADS>:上传目录, 例如/sharedfolders

• <PATH TO TEMP>: 临时下载文件夹，需要与Aria的/downloads对应，例如/dockercnf/aria2/temp（如不需要离线下载功能#1可以删除）

• <PATH TO conf.ini>: 配置文件，如/dockercnf/cloudreve/conf.ini

• <PATH TO cloudreve.db>: 数据库文件，如/dockercnf/cloudreve/cloudreve.db

Step7. 配置Cloudreve连接Aria2服务器

• 以管理员身份登陆

• 点击"头像（右上角） > 管理面板"

• 点击"参数设置 > 离线下载"

  • RPC服务器地址: http://aria2:6800/⁠
  • RPC Secret: 参见启动Aria2服务中的<SECRET>
  • 临时下载地址: /downloads
  • 其他选项按照默认值即可

• 测试连接并保存

⁠Docker Compose方式运行

前提

• 已安装docker，如果没有请执行wget -qO- https://get.docker.com/ | bash安装docker。
• 已安装docker compose，如果没有请参考Install Docker Compose⁠。
• 一个域名并解析到运行Cloudreve的服务器，这里以cloudreve.example.com为例。
• 确保80和443端口没有被占用，如果您已经有服务器软件（如Nginx或Caddy），请考虑为原有服务器软件增加配置文件并删除docker compose配置文件中的caddy容器。

Step1. 预创建文件

Caddy配置文件

mkdir -p /dockercnf/caddy \
	&& vim /dockercnf/caddy/Caddyfile

填入以下信息

cloudreve.example.com {
  tls [email protected]
  proxy / cloudreve:5212 {
    transparent
  }
}

Cloudreve配置文件及数据库文件

mkdir -p /dockercnf/cloudreve \
	&& touch /dockercnf/cloudreve/conf.ini \
	&& touch /dockercnf/cloudreve/cloudreve.db

Step2. 下载环境文件以及Docker Compose文件

下载环境文件

wget -qO- https://raw.githubusercontent.com/xavier-niu/cloudreve-docker/master/docker-compose-env-example > .env

根据需要对环境变量进行修改

• 必填项
  • CLOUDREVE_PUID: PUID的获取方式详见获取PUID和PGID
  • CLOUDREVE_PGID: PGID的获取方式详见获取PUID和PGID
  • ARIA2_RPC_SECRET: Aria2 RPC密码（你可以去这里⁠生成随机字符串）。请记下该密码！在后续Cloudreve设置Aria2中会使用。
• 选填项（如无特殊需要不建议修改）
  • CADDY_CERTS_PATH: Caddy自动获取证书文件夹路径
  • CADDY_CADDYFILE_PATH: Caddyfile配置文件路径
  • TEMP_FOLDER_PATH: 离线下载临时文件夹路径
  • ARIA2_CONFIG_PATH: Aria2的配置文件夹路径
  • CLOUDREVE_UPLOAD_PATH: Cloudreve上传文件夹路径
  • CLOUDREVE_CONF_INI_PATH: Cloudreve配置文件路径
  • CLOUDREVE_DB_PATH: Cloudreve数据库文件路径

下载Docker Compose文件

wget -qO- https://raw.githubusercontent.com/xavier-niu/cloudreve-docker/master/docker-compose-amd64.yml > docker-compose.yml

Step3. 启动Docker Compose

docker-compose up -d

说明

• Aria2-RPC会暴露于外网，访问端口6800，Secret为你对ARIA2_RPC_SECRET设置的随机字符串。

Step4. 配置Cloudreve连接Aria2服务器

• 以管理员身份登陆

• 点击"头像（右上角） > 管理面板"

• 点击"参数设置 > 离线下载"

  • RPC服务器地址: http://aria2:6800/
  • RPC Secret: 你对ARIA2_RPC_SECRET设置的随机字符串
  • 临时下载地址: /downloads
  • 其他选项按照默认值即可

• 测试连接并保存

⁠升级

首先请暂停并移除正在运行的容器并从DockerHub拉取最新的镜像

docker stop cloudreve \
  && docker rm cloudreve \
  && docker pull xavierniu/cloudreve

重复上面的运行步骤再次启动容器即可。

⁠有疑问？

如果有任何问题可以在GitHub中创建一个新的issue或者通过邮件a#nxw.name与我取得联系。