webui-aria2 README

The project's README from github.com/ziahamza/webui-aria2. As one markdown file: README.md.

WebUI-Aria2

Main interface

The aim for this project is to create the worlds best and hottest interface to interact with aria2. aria2 is the worlds best file downloader, but sometimes the command line brings more power than necessary. The project was initially created as part of the GSOC scheme, however it has rapidly grown and changed with tremendous support and feedback from the aria2 community.

Very simple to use, no build scripts, no installation scripts. First start aria2 in the background either in your local machine or in a remote one. You can do that as follows:

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

If aria2 is not installed in your local machine then head on to https://aria2.github.io/ and follow the instructions there.

Then to use the WebUI-Aria2,

node node-server.js

Tips

  1. You can always select which files to download in case of torrents or metalinks. Just pause a download and a list icon should appear next to the settings button. To select which files to download before starting the download, give the flag --pause-metadata to aria2. See link

Configuration

Read and edit configuration.js.

DirectURL

This feature allows users to download files that they download from aria2 directly from the webui dashboard. If you are familiar with how webservers work, setup a http server that points at the configured aria2 download directory, check permissions. Then Specify a full url: http://server:port/ in the webui directURL configuration.

If the above is not obvious, keep reading what this is about in directurl.md

Dependencies

Well, you need aria2. And a web browser (if that even counts!)

Docker support

There is two Dockerfile in this project, one is a common Dockerfile, which can be use for testing purpose.
The second is a production ready Dockerfile for arm32v7 platforms (including Raspberry Pi).

For testing purpose

You can also try or use webui-aria2 in your LAN inside a Docker sandbox.

Build the image

sudo docker build -t yourname/webui-aria2 .

..and run it! It will be available at: http://localhost:9100

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

/Downloads is the directory in the host where you want to keep the downloaded files

Production ready (ARM platform)

This image contains both aria2 and webui-aria2.

Build it (may take several hours due to the aria2 compilation process. Don't panic and grab a coffee).

docker build -f Dockerfile.arm32v7 -t yourname/webui-aria2 .

This command will ends up building three images:


Prepare the host volume: This image required few file to be mounted in the container. ``` /home/aria/aria2/session.txt (empty file) /home/aria/aria2/aria2.log (empty file) /home/aria/aria2/aria2.conf (aria2 configuration file, not webui-aria2 conf) must contains at least `enable-rpc=true` and `rpc-listen-all=true` /data/downloads/ (where the downloaded files goes) ```

Run it

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

Contributing

Checkout contributor's guide to know more about how to contribute to this project.

Deploy to Heroku

Deploy

Support

For any support, feature request and bug report add an issue in the github project. link

License

Refer to the LICENSE file (MIT License). If the more liberal license is needed then add it as an issue

webui-aria2 (ziahamza/webui-aria2)

progressive-web-app
Searching Database…

10.4K ·GitHub
Webui-aria2
What is this?A browser-based dashboard for aria2, the command-line file downloader, so you can manage your downloads from a web UI instead of the terminal.
Is it a program I install, or just a web page?It is a pure frontend: no build scripts, no installation scripts. You just open index.html from the docs folder in any browser, while aria2 runs separately in the background.
How do I get it up and running?Start aria2 in the background on your machine or a remote one, then either open index.html from the docs folder, visit the hosted copy, or serve the project folder with the included NodeJS server.
What do I need to install besides the interface itself?Just aria2, which you install separately, and a web browser — that is the entire dependency list.
What is the trickiest part to set up?The DirectURL feature, which lets you grab finished files straight from the dashboard: you need to run your own HTTP server over aria2's download folder and put its URL in the webui config.
Where does it run?In any web browser. There are also Docker setups — a simple one for your LAN and a production image for ARM boards like the Raspberry Pi — plus a Heroku deploy option.
Does it still work without an internet connection?Yes. After you open the URL once, it behaves like a Progressive Web App and can be reopened even when you are offline.
Can I pick individual files inside a torrent before it starts?Yes. Pause a download and a list icon appears next to the settings button letting you select files; to choose before the download even starts, launch aria2 with the --pause-metadata flag.
Do I have to download anything to try it?No — the README points to a hosted copy you can open in any browser and start using immediately. After that first visit it keeps working offline as a PWA.
Why does the README call it the 'worlds best and hottest' interface?That is the author's stated goal. The project began as a GSOC project and has grown rapidly thanks to tremendous support and feedback from the aria2 community.
What are similar projects?AriaNg, Motrix, openGym, dashy, steam2_downloader, dockge, LinkSwift, rayburst
Which topics is it in?aria2, icon, progressive-web-app, heroku, bittorrent, http-server, arm, rpc, webui, downloader, raspberry-pi, offline
Creator
ziahamza
Size
15.8 MB
Stars
10.4K
Updated
CommitSep 01
Age
14y
Commits · 90 Days