Cloudreve
搜索文档…
快速开始

获取 Cloudreve

你可以在 GitHub Release 页面获取已经构建打包完成的主程序。其中每个版本都提供了常见系统架构下可用的主程序,命名规则为cloudreve_版本号_操作系统_CPU架构.tar.gz 。比如,普通64位Linux系统上部署3.0.0版本,则应该下载cloudreve_3.0.0_linux_amd64.tar.gz
如果你想体验最新的功能特性,可以在 GitHub Actions 中下载每次 commit 后构建的开发版。注意,开发版并不稳定,无法用于生产用途,且不保证完全可用。
如果想要自行从源代码构建,请参阅以下章节:

启动 Cloudreve

Linux
Windows
Linux下,直接解压并执行主程序即可:
1
#解压获取到的主程序
2
tar -zxvf cloudreve_VERSION_OS_ARCH.tar.gz
3
4
# 赋予执行权限
5
chmod +x ./cloudreve
6
7
# 启动 Cloudreve
8
./cloudreve
Copied!
Windows下,直接解压获取到的 zip 压缩包,启动 cloudreve.exe 即可。
Cloudreve 在首次启动时,会创建初始管理员账号,请注意保管管理员密码,此密码只会在首次启动时出现。如果您忘记初始管理员密码,需要删除同级目录下的cloudreve.db,重新启动主程序以初始化新的管理员账户。
Cloudreve 默认会监听5212端口。你可以在浏览器中访问http://服务器IP:5212进入 Cloudreve。
以上步骤操作完后,最简单的部署就完成了。你可能需要一些更为具体的配置,才能让Cloudreve更好的工作,具体流程请参考下面的配置流程。

可选部署流程

反向代理

在自用或者小规模使用的场景下,你完全可以使用 Cloudreve 内置的 Web 服务器。但是如果你需要使用HTTPS,亦或是需要与服务器上其他 Web 服务共存时,你可能需要使用主流 Web 服务器反向代理 Cloudreve ,以获得更丰富的扩展功能。
你需要在Web服务器中新建一个虚拟主机,完成所需的各项配置(如启用HTTPS),然后在网站配置文件中加入反代规则:
NGINX
Apache
在网站的server字段中加入:
1
location / {
2
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
3
proxy_set_header Host $http_host;
4
proxy_redirect off;
5
proxy_pass http://127.0.0.1:5212;
6
7
# 如果您要使用本地存储策略,请将下一行注释符删除,并更改大小为理论最大文件尺寸
8
# client_max_body_size 20000m;
9
}
Copied!
VirtualHost字段下加入反代配置项ProxyPass,比如:
1
<VirtualHost *:80>
2
ServerName myapp.example.com
3
ServerAdmin [email protected]
4
DocumentRoot /www/myapp/public
5
6
# 以下为关键部分
7
AllowEncodedSlashes NoDecode
8
ProxyPass "/" "http://127.0.0.1:5212/" nocanon
9
10
</VirtualHost>
Copied!

进程守护

以下两种方式可任选其一。

Systemd

1
# 编辑配置文件
2
vim /usr/lib/systemd/system/cloudreve.service
Copied!
将下文 PATH_TO_CLOUDREVE 更换为程序所在目录:
1
[Unit]
2
Description=Cloudreve
3
Documentation=https://docs.cloudreve.org
4
After=network.target
5
After=mysqld.service
6
Wants=network.target
7
8
[Service]
9
WorkingDirectory=/PATH_TO_CLOUDREVE
10
ExecStart=/PATH_TO_CLOUDREVE/cloudreve
11
Restart=on-abnormal
12
RestartSec=5s
13
KillMode=mixed
14
15
StandardOutput=null
16
StandardError=syslog
17
18
[Install]
19
WantedBy=multi-user.target
Copied!
1
# 更新配置
2
systemctl daemon-reload
3
4
# 启动服务
5
systemctl start cloudreve
6
7
# 设置开机启动
8
systemctl enable cloudreve
Copied!
管理命令:
1
# 启动服务
2
systemctl start cloudreve
3
4
# 停止服务
5
systemctl stop cloudreve
6
7
# 重启服务
8
systemctl restart cloudreve
9
10
# 查看状态
11
systemctl status cloudreve
Copied!

Supervisor

首先安装supervisor,已安装的可以跳过。
1
# 安装 supervisor
2
sudo yum install python-setuptools
3
sudo easy_install supervisor
4
5
# 初始化全局配置文件
6
sudo touch /etc/supervisord.conf
7
sudo echo_supervisord_conf > /etc/supervisord.conf
Copied!
编辑全局配置文件:
1
sudo vim /etc/supervisord.conf
Copied!
将文件底部的[include] 分区注释符号;删除,加入新的配置文件包含路径:
1
[include]
2
files = /etc/supervisor/conf/*.conf
Copied!
创建 Cloudreve 应用配置所在文件目录,并创建打开配置文件:
1
sudo mkdir -p /etc/supervisor/conf
2
sudo vim /etc/supervisor/conf/cloudreve.conf
Copied!
根据实际情况填写以下内容并保存:
1
[program:cloudreve]
2
directory=/home/cloudreve
3
command=/home/cloudreve/cloudreve
4
autostart=true
5
autorestart=true
6
stderr_logfile=/var/log/cloudreve.err
7
stdout_logfile=/var/log/cloudreve.log
8
environment=CODENATION_ENV=prod
Copied!
其中以下配置项需要根据实际情况更改:
    directory: Clopudreve 主程序所在目录
    command: Cloudreve 主程序绝对路径
    stderr_logfile: 错误日志路径
    stdout_logfile: 通常日志路径
通过全局配置文件启动supervisor:
1
supervisord -c /etc/supervisord.conf
Copied!
日后你可以通过以下指令管理 Cloudreve 进程:
1
# 启动
2
sudo supervisorctl start cloudreve
3
4
# 停止
5
sudo supervisorctl stop cloudreve
6
7
# 查看状态
8
sudo supervisorctl status cloudreve
Copied!

Docker

你可以选择使用以下镜像部署:
最近更新 9mo ago