Aria2 + AriaNg + Filebrowser
English | 简体中文
If you like this project, please consider sponsoring me / 如果喜欢本项目,请考虑打赏,谢谢!
- Features
- Recommended versions
- How to run
- Auto HTTPS enabling
- Build the image by yourself
- Docker Hub
- Running it on Kubernetes (My favorite)
- Running it with Docker compose
- FAQ
One Docker image for file downloading, managing, sharing, as well as video playing and evening cloud storage synchronization.
Furthermore, it's pretty small and ARM CPU compatible which means you can also run it on Raspberry Pi🍓.
Last but not least, Auto HTTPS can't be more easy!
- Aria2 (SSL support)
- AriaNg
- Rclone
- File Browser: Files mangement and videos playing
- Auto HTTPS (Let's Encrypt)
- Bind non root user into container, so non root user can also manage downloaded files.
- Basic Auth
- Support ARM CPUs as well, all supported CPU platforms can be found here
- Cloud Storage platforms synchronization
- wahyd4/aria2-ui:latest
Docker will pick the the proper ARCH for you. e.g. arm64v8 or x86_64
docker run -d --name aria2-ui -p 80:80 wahyd4/aria2-ui
- Aria2: http://yourip
- FileManger: http://yourip/files
- Rclone: http://yourip/rclone
- Please use
admin
/admin
as username and password to loginFilebrowser
for the first time. And useuser
/password
to loginRclone
if you don't updateARIA2_USER
andARIA2_PWD
docker run -d --name ariang \
-p 80:80 \
-p 443:443 \
-e PUID=1000 \
-e PGID=1000 \
-e ENABLE_AUTH=true \
-e RPC_SECRET=Hello \
-e DOMAIN=https://example.com \
-e ARIA2_SSL=false \
-e ARIA2_USER=user \
-e ARIA2_PWD=password \
-e ARIA2_EXTERNAL_PORT=443 \
-v /yourdata:/data \
-v /app/a.db:/app/filebrowser.db \
-v /to_yoursslkeys/:/app/conf/key \
-v <conf files folder>:/app/conf \
wahyd4/aria2-ui
If you would like to get rid of those annoying command line commands, then just put the following sample content into docker-compose.yaml
version: "3.5"
services:
aria2-ui:
restart: unless-stopped
image: wahyd4/aria2-ui:latest
environment:
- ENABLE_AUTH=true
- ARIA2_USER=hello
- ARIA2_PWD=world
- DOMAIN=http://toozhao.com
ports:
- "80:80"
volumes:
- ./data:/data
Then simply run docker-compose up -d
, that's it!
ENABLE_AUTH
whether to enable Basic authENABLE_RCLONE
whether to disable Rclone, if you running this container offline or do not have stable connection to Github, please set tofalse
ARIA2_USER
Basic Auth username, Rclone GUI uses it as well.ARIA2_PWD
Basic Auth password, Rclone GUI uses it as well.ARIA2_EXTERNAL_PORT
The Aria2 port which exposed to public to access toPUID
Bind Linux UID into container which means you can use nonroot
user to manage downloaded files, default UID is1000
PGID
Bind Linux GID into container, default GID is 1000RPC_SECRET
The Aria2 RPC secret tokenDOMAIN
The domain you'd like to bind, when domain is ahttps://
thing, then auto TLS feature will be enabledRCLONE_CONFIG_BASE64
Inject and config Rclone throughbase64
string, which is the only way to use Rclone on Heroku. Please usecat /app/conf/rclone.conf | base64
or any base64 online tools such as this to encode yourrclone.conf
as bse64 string. Note, you need to setENABLE_RCLONE
to true as well.ENABLE_APP_CHECKER
, by default it's set totrue
to check if any new docker image version release on daily basis, which can help you get notification when new features released as well as some security vulnerabilities get fixed. You can set it tofalse
to disable this feature. Note: you still need to manually pull the new image version and re run the docker container to complete upgrading.
-
/data
The folder contains all the files you download. -
/app/conf/key
The folder which stores Aria2 SSLcertificate
andkey
file.Notice
: The certificate file should be namedaria2.crt
and the key file should be namedaria2.key
-
/app/conf
The Aria2 configuration and file session folder. Make sure you havearia2.conf
andaria2.session
file. For the first timearia2.session
just need to be a empty file can be appended. You can also user the templates for these two file in theconf
folder of this project. Please put yourrclone.conf
in this folder as well if you'd mount it to Rclone. So all the config files supported in this folder are:- aria2.conf
- aria2.session
- rclone.conf
Warning: if you don't mount
/app/conf
, whenever the container restarts, you'll lose your downloading progress. -
/app/filebrowser.db
File Browser settings database, make sure you make a empty file first on your host.
Make sure you have added proper A
record point to the host you running to your domain DNS
record list, then just add e
option to bind the https
domain when you run the image
docker run -d --name aria2-ui -p 80:80 -p 443:443 -e DOMAIN=https://toozhao.com wahyd4/aria2-ui
docker buildx build --platform linux/arm/v7,linux/arm64,linux/amd64 -t aria2-ui .
https://hub.docker.com/r/wahyd4/aria2-ui/
First of all, I have to say running this docker image on Kubernetes is more challenging and requires more knowledges than running it in raw Docker, but which is more powerful.
I couldn't tell you how to run it in Kubernetes step by step, but once you have a running Kubernetes cluster(You can install Kubernetes via minikube
, Docker desktop app
, kubeadm
and many other tools.), then you can modify the k8s-manifest.yaml to satisfy all your requirements. Such as:
- NFS PV provider(Use your NAS as storage)
- Ingress access, Oauth login, more access controls via Nginx etc.
- VPN tunnel (Secure your traffic)
- Sidecars and so on.
Please refer https://github.com/wahyd4/aria2-ariang-x-docker-compose
- When you running the docker image with non
80
port or you have HTTPS enabled, you will meet the error saysAria2 Status Disconnected
, then you will need to setARIA2_EXTERNAL_PORT
and recreate your container. - If there is no speed at all when you downloading a BitTorrent file, please try to use a popular torrent file first to help the application to cache
DHT
file. Then the speed should get fast and fast, as well as downloading other links. - If you see any errors related to
setcap
which probably means the Linux you are running doesn't support running this application withnon-root
user. So please specify thePUID
andPGID
to0
explicitly to useroot
user to run it. - How can I get
Rclone
authenticated? Due to Rclone is running in this docker image only as a component rather than an application, you can only interact with it via/rclone
endpoint, and no other ports. So the web browser authentication mechanism doesn't work here. Please configure Rclone through command line within the container. You can follow the official doc Configuring rclone on a remote / headless machine or this issue