在服务器上搭建 Aria2 RPC 服务

以前写爬虫都是自己写下载器抓静态资源;后来改成把资源路径写入数据库,再交给 NAS 上的 aria2c 后台下载,并通过 Web 界面管理任务。整体链路如下:

1
2
浏览器(AriaNg) ──> Nginx ──> /jsonrpc ──> aria2c(RPC,仅监听 127.0.0.1:6800)
└──> / ─────────> AriaNg 静态文件

本文基于 Arch Linux(yay),其他发行版替换包管理器即可;文中路径均为示例,请按实际情况修改。

一、安装 Aria2

1
2
3
4
5
6
7
8
9
10
# Arch Linux
yay -S aria2

# Debian / Ubuntu
sudo apt install aria2

# CentOS / Rocky
sudo dnf install aria2

aria2c --version

二、配置 RPC

1
2
3
sudo mkdir -p /etc/aria2c
sudo touch /etc/aria2c/aria2.session
sudo vim /etc/aria2c/aria2.conf

/etc/aria2c/aria2.conf 示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# ---------- 下载 ----------
dir=/srv/aria2/downloads # 下载目录(需提前创建且运行用户可写)
continue=true # 断点续传
max-concurrent-downloads=5 # 同时下载的任务数
max-connection-per-server=8 # 单服务器连接数
split=8 # 单文件最大分段数(线程数)
min-split-size=1M # 最小分片大小
disk-cache=64M
file-allocation=none

# ---------- 会话(保存未完成任务进度) ----------
input-file=/etc/aria2c/aria2.session
save-session=/etc/aria2c/aria2.session
save-session-interval=60

# ---------- RPC ----------
enable-rpc=true
rpc-listen-port=6800
rpc-listen-all=false # false=仅监听 127.0.0.1;改成 true 才是监听所有网卡
rpc-secret=change-me-before-use # 必须设置,否则任何能访问端口的人都能下发任务
# rpc-allow-origin-all=true # 仅当浏览器跨域直连 RPC 时需要,Nginx 同源反代不需要

# ---------- 速度限制(0 = 不限制) ----------
max-overall-download-limit=0
max-overall-upload-limit=0

# ---------- 代理(可选) ----------
# all-proxy=socks5://127.0.0.1:1080

几个容易踩的点:

  • rpc-listen-all=false 时只监听 127.0.0.1;一旦改成 true,RPC 就对整个网络开放——必须同时设置 rpc-secret,并靠防火墙限制来源;
  • rpc-secret 一旦设置,所有 RPC 请求都要在 params 里带上 token:<secret>;
  • rpc-allow-origin-all=true 是给"浏览器跨域直连 RPC"用的(比如 AriaNg 部署在另一台机器);走 Nginx 同源反代时不需要,开了反而多一处暴露面;
  • aria2.session 必须先 touch 创建,否则启动时直接报文件不存在;
  • 下载目录要对 systemd 服务的运行用户可写(默认以 root 运行,需要调整时见第三节)。

三、配置 systemd

创建 /etc/systemd/system/aria2c.service:

1
2
3
4
5
6
7
8
9
10
11
12
13
[Unit]
Description=Aria2c Download Service
After=network.target
Wants=network.target

[Service]
Type=simple
ExecStart=/usr/bin/aria2c --conf-path=/etc/aria2c/aria2.conf
Restart=on-failure
RestartSec=5

[Install]
WantedBy=multi-user.target
1
2
3
sudo systemctl daemon-reload
sudo systemctl enable --now aria2c.service
systemctl status aria2c.service

早期文章里有一处笔误:把 service 拷贝到了 /usr/lib/systemd/system/aria2c.session,而 systemctl enable aria2c.service 又在找 aria2c.service,必然报 Unit aria2c.service not found。Unit 文件路径 / 文件名必须与 enable 的名字一致。

如果不想以 root 运行:

1
2
3
[Service]
User=aria2
Group=aria2

并给下载目录和 session 文件赋权:

1
sudo chown -R aria2:aria2 /srv/aria2 /etc/aria2c

四、验证 RPC

1
2
3
curl -s -X POST http://127.0.0.1:6800/jsonrpc \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":"q","method":"aria2.getVersion","params":["token:change-me-before-use"]}'

返回类似:

1
{"id":"q","jsonrpc":"2.0","result":{"enabledFeatures":["..."],"version":"1.37.0"}}

若能返回结果,说明 RPC 已正常工作。

五、安装 AriaNg

Arch 下用打包好的静态文件:

1
yay -S aria-ng-deploy

安装脚本只会打印一句提示:you should copy /usr/share/aria-ng-deploy to your web directory——手动复制即可:

1
2
sudo mkdir -p /srv/www/aria2ng
sudo cp -r /usr/share/aria-ng-deploy/. /srv/www/aria2ng/

也可以直接从 AriaNg Releases 下载压缩包,解压到同一个 Web 目录(纯静态站点,无需 PHP/Node)。

六、配置 Nginx

在 /etc/nginx/nginx.conf 的 http 块中确认有类似以下引入(Arch 通常为 /etc/nginx/conf.d/*.conf,Debian 为 sites-enabled/*),然后新增站点配置,例如 /etc/nginx/conf.d/aria2ng.conf:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
server {
listen 80;
listen [::]:80;
server_name aria2.example.com; # 域名或内网 IP

root /srv/www/aria2ng;
index index.html;

# AriaNg 静态文件
location / {
try_files $uri $uri/ /index.html;
}

# 同源反代 JSON-RPC,浏览器在同源下调用 /jsonrpc,
# 避免直接暴露 aria2 的 6800 端口
location /jsonrpc {
proxy_pass http://127.0.0.1:6800/jsonrpc;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Content-Type "application/json";
proxy_read_timeout 60s;
}

# 禁止访问隐藏文件
location ~ /\. {
deny all;
}
}
1
2
sudo nginx -t
sudo systemctl reload nginx

浏览器打开 http://aria2.example.com,进入 AriaNg 的 RPC 设置:

  • RPC 地址:/jsonrpc(相对路径,同源即可)
  • 协议:http
  • 密钥(Secret Token):填 token:change-me-before-use

如果不想走反代

也可以把 RPC 端口直接暴露出去(AriaNg 与 aria2 不同源):

1
2
3
rpc-listen-all=true
rpc-allow-origin-all=true
rpc-secret=change-me-before-use

然后在 AriaNg 里 RPC 地址填 http://<服务器IP>:6800/jsonrpc。这种方式会多暴露一个端口,务必同时配置防火墙,仅在可信网络使用。

若使用 WebSocket(ws://.../jsonrpc),Nginx 侧还要补上:

1
2
3
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

七、常见问题排查

现象可能原因
systemctl enable aria2c.service 报 unit 未找到service 文件名/路径写错(如早期的 .session)
启动即失败,报 session/input 文件不存在没有先 touch aria2.session
下载目录写入失败运行用户无权限(默认 root;配置 User= 后要 chown)
AriaNg 一直"正在连接"rpc-listen-all、rpc-secret、端口三者不一致;用第四节的 curl 先验证
连接被拒绝服务端只监听 127.0.0.1,而 AriaNg 从别的机器直连
打开页面 404 / 空白Nginx root 指向的目录、index 文件名不对
任务进度重启后丢失save-session / input-file 路径不可写

八、参考资料

  1. aria2 官方手册(aria2c) —— RPC 选项、会话保存与下载参数;
  2. aria2 GitHub;
  3. JSON-RPC 2.0 规范 —— 请求格式与错误码;
  4. AriaNg Releases —— 静态管理界面;
  5. Nginx 官方文档:ngx_http_proxy_module —— /jsonrpc 反代与 WebSocket 升级;
  6. systemd.service 手册 —— Unit 配置语义。

九、小结

  • aria2c 通过 systemd 常驻,rpc-listen-all=false 只监听本机;
  • Nginx 托管 AriaNg 静态文件,并把 /jsonrpc 反代到 127.0.0.1:6800,浏览器同源访问;
  • AriaNg 的 RPC 地址填 /jsonrpc、密钥填 token:<secret>;
  • 重启后未完成任务通过 aria2.session 恢复,断点续传照常可用。

在服务器上搭建 Aria2 RPC 服务
https://bubao.github.io/posts/311d2e0a.html
作者
一念
发布于
2020年8月1日
许可协议