fjudith/webui-aria2

webui-aria2

镜像概述和主要用途

webui-aria2旨在为Aria2（一款高效文件下载器）提供直观的网页管理界面，简化命令行操作复杂度。该项目最初作为GSOC计划的一部分开发，后在Aria2社区支持下持续发展，支持本地及远程Aria2实例管理，无需复杂构建或安装脚本，通过浏览器即可轻松控制下载任务。

核心功能和特性

• 简单易用：无需构建或安装脚本，直接通过浏览器运行，支持离线保存使用
• 文件选择：支持在torrent或metalink下载中选择特定文件，暂停下载后可显示文件列表
• DirectURL功能：配置后可从WebUI直接下载Aria2已下载的文件
• Docker支持：提供测试用镜像和ARM平台（如树莓派）生产就绪镜像，包含Aria2及WebUI

使用场景和适用范围

• 需要通过网页界面管理Aria2下载任务的用户
• 本地或远程服务器上Aria2实例的可视化管理
• ARM设备（如树莓派）的生产环境部署
• 希望避免命令行操作Aria2的用户

详细使用方法和配置说明

前提条件

• 安装Aria2（参考https://aria2.github.io/）
• 现代Web浏览器

基本使用方法

1. 启动Aria2 RPC服务
   在本地或远程服务器后台启动Aria2并启用RPC：

   bash
   aria2c --enable-rpc --rpc-listen-all
   

2. 访问WebUI

   • 下载仓库后在浏览器中打开index.html
   • 直接访问https://ziahamza.github.io/webui-aria2/
   • 通过浏览器"保存页面"功能离线使用
   • 或通过Node.js启动本地服务器：

     bash
     node node-server.js
     

Docker部署

测试用镜像

适用于局域网内测试，包含WebUI服务。

1. 构建镜像：

   bash
   sudo docker build -t yourname/webui-aria2 .
   

2. 运行容器（访问地址：http://localhost:9100）：

   bash
   sudo docker run -v /Downloads:/data -p 6800:6800 -p 9100:8080 --name="webui-aria2" yourname/webui-aria2
   

   • /Downloads：主机存放下载文件的目录
   • 端口映射：6800为Aria2 RPC端口，9100为WebUI访问端口

生产用镜像（ARM平台）

适用于树莓派等ARM设备，包含Aria2及WebUI，支持持久化配置。

1. 构建镜像（因Aria2编译过程可能需数小时）：

   bash
   docker build -f Dockerfile.arm -t yourname/webui-aria2 .
   

2. 准备主机卷（需挂载到容器/data目录）：

   • .aria2/session.txt：空文件（用于Aria2会话保存）
   • .aria2/aria2.log：空文件（Aria2日志）
   • .aria2/aria2.conf：Aria2配置文件，至少包含：

     ini
     enable-rpc=true
     rpc-listen-all=true
     

   • ./downloads/：存放下载文件的目录

3. 运行容器：

   bash
   docker run --restart=always -d -v /home/<USER>/data/aria2:/data -p 6800:6800 -p 9100:8080 --name="webui-aria2" docker.xuanyuan.run/yourname/webui-aria2
   

配置说明

基础配置

编辑项目根目录的configuration.js文件，自定义WebUI行为。

DirectURL功能

允许从WebUI直接下载Aria2已下载的文件：

1. 搭建HTTP服务器，指向Aria2下载目录并配置权限
2. 在WebUI配置中指定完整URL（如http://server:port/）
3. 详细说明参考directurl.md

使用技巧

• 文件选择：暂停torrent/metalink下载后，点击设置按钮旁的列表图标选择文件
• 预选择文件：启动Aria2时添加--pause-metadata标志，可在开始下载前选择文件（参考https://aria2.github.io/manual/en/html/aria2c.html#cmdoption--pause-metadata）

依赖

• Aria2（必须）
• Web浏览器（现代浏览器即可）

支持与反馈

通过https://github.com/ziahamza/webui-aria2/issues提交issue获取支持、功能请求或报告bug。

许可证

MIT许可证，详见LICENSE文件。如需更宽松许可证，可提交issue协商。