|
|
|
@@ -4,7 +4,7 @@ English | [简体中文](https://github.com/wahyd4/aria2-ariang-docker/blob/mast
|
|
|
|
|
|
|
|
|
|
[](https://microbadger.com/images/wahyd4/aria2-ui "Get your own image badge on microbadger.com")
|
|
|
|
|
[](https://hub.docker.com/r/wahyd4/aria2-ui/)
|
|
|
|
|
[](https://github.com/wahyd4/aria2-ariang-docker/actions)
|
|
|
|
|
[](https://github.com/wahyd4/aria2-ariang-docker/actions)
|
|
|
|
|
|
|
|
|
|
[](https://badges.toozhao.com/stats/aria2-ariang-docker "Page Views Count")
|
|
|
|
|
|
|
|
|
@@ -23,6 +23,9 @@ English | [简体中文](https://github.com/wahyd4/aria2-ariang-docker/blob/mast
|
|
|
|
|
- [Supported Environment Variables](#supported-environment-variables)
|
|
|
|
|
- [Supported Volumes](#supported-volumes)
|
|
|
|
|
- [Auto HTTPS enabling](#auto-https-enabling)
|
|
|
|
|
- [Download Automation 🤖](#download-automation-)
|
|
|
|
|
- [Download file through iPhone/Mac Shortcuts app.](#download-file-through-iphonemac-shortcuts-app)
|
|
|
|
|
- [Download file through cURL](#download-file-through-curl)
|
|
|
|
|
- [Build the image by yourself](#build-the-image-by-yourself)
|
|
|
|
|
- [Docker Hub](#docker-hub)
|
|
|
|
|
- [Running it on Kubernetes (My favorite)](#running-it-on-kubernetes-my-favorite)
|
|
|
|
@@ -65,12 +68,12 @@ File Browser
|
|
|
|
|
### Quick run
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
docker run -d --name aria2-ui -p 80:80 wahyd4/aria2-ui
|
|
|
|
|
docker run -d --name aria2-ui -p 8000:80 wahyd4/aria2-ui
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
* Aria2: <http://yourip>
|
|
|
|
|
* FileManger: <http://yourip/files>
|
|
|
|
|
* Rclone: <http://yourip/rclone>
|
|
|
|
|
* Aria2: <http://yourip:8000>
|
|
|
|
|
* FileManger: <http://yourip:8000/files>
|
|
|
|
|
* Rclone: <http://yourip:8000/rclone>
|
|
|
|
|
* Please use `admin`/`admin` as username and password to login `Filebrowser` for the first time. And use `user`/`password` to login `Rclone` if you don't update `ARIA2_USER` and `ARIA2_PWD`
|
|
|
|
|
|
|
|
|
|
### Full features run
|
|
|
|
@@ -131,11 +134,12 @@ Then simply run `docker-compose up -d`, that's it!
|
|
|
|
|
| `DOMAIN` | The domain you'd like to bind, when domain is a `https://` thing, then auto TLS feature will be enabled |
|
|
|
|
|
| `RCLONE_CONFIG_BASE64` | Inject and config Rclone through `base64` string, which is the only way to use Rclone on Heroku. Please use `cat /app/conf/rclone.conf \| base64` or any base64 online tools such as [this](https://www.base64encode.org/) to encode your `rclone.conf` as bse64 string. Note, you need to set `ENABLE_RCLONE` to true as well. |
|
|
|
|
|
| `ENABLE_APP_CHECKER` | By default it's set to `true` 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 to `false` to disable this feature. Note: you still need to manually pull the new image version and re run the docker container to complete upgrading. |
|
|
|
|
|
| CADDY_LOG_LEVEL | For specifying the log level of Caddy, set it to `ERROR` to reduce logs. Default: `INFO` |
|
|
|
|
|
| RCLONE_AUTO_UPLOAD_PROVIDER | The Rclone remote storage provider name, which can be found under `Rclone -> Configs`, default `""`, which means auto upload is disabled. When the value is not empty, then the files will be attempted to be uploaded.|
|
|
|
|
|
| RCLONE_AUTO_UPLOAD_REMOTE_PATH | The file folder in remote cloud storage provider, default `/downloads`|
|
|
|
|
|
| RCLONE_AUTO_UPLOAD_FILE_MIN_SIZE | Set the minimum file size of auto uploader, files smaller than it won't be uploaded, default `1K` |
|
|
|
|
|
| RCLONE_AUTO_UPLOAD_FILE_MAX_SIZE | Set the limit of the Max file can be uploaded to 3rd party storage provider, default `100G`. |
|
|
|
|
|
| `CADDY_LOG_LEVEL` | For specifying the log level of Caddy, set it to `WARN` or`ERROR` to reduce logs. Default: `INFO` |
|
|
|
|
|
| `RCLONE_AUTO_UPLOAD_PROVIDER` | The Rclone remote storage provider name, which can be found under `Rclone -> Configs`, default `""`, which means auto upload is disabled. When the value is not empty, then the files will be attempted to be uploaded.|
|
|
|
|
|
| `RCLONE_AUTO_UPLOAD_REMOTE_PATH` | The file folder in remote cloud storage provider, default `/downloads`|
|
|
|
|
|
| `RCLONE_AUTO_UPLOAD_FILE_MIN_SIZE` | Set the minimum file size of auto uploader, files smaller than it won't be uploaded, default `1K` |
|
|
|
|
|
| `RCLONE_AUTO_UPLOAD_FILE_MAX_SIZE` | Set the limit of the Max file can be uploaded to 3rd party storage provider, default `100G`. |
|
|
|
|
|
| `FIX_DATA_VOLUME_PERMISSIONS` | Default value is `false`. When set to `true`, the container will run `chown -R` command against `/data` folder and `PUID` and `PGID` you set. Please set it to `true` when container complains you don't have enough permissions to manage the files and folders you mounted.|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Supported Volumes
|
|
|
|
@@ -144,7 +148,7 @@ Then simply run `docker-compose up -d`, that's it!
|
|
|
|
|
|:---|:---|
|
|
|
|
|
| `/data` | The folder contains all the files you download. |
|
|
|
|
|
| `/app/conf/key` | The folder which stores Aria2 SSL `certificate` and `key` |file. `Notice`: The certificate file should be named `aria2.crt` and the key file should be named `aria2.key` |
|
|
|
|
|
| `/app/conf` | The Aria2 configuration and file session folder. Make sure you have `aria2.conf` and `aria2.session` file. For the first time `aria2.session` just need to be a empty file can be appended. You can also user the templates for these two file in the `conf` folder of this project. Please put your `rclone.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/conf` | The Aria2 configuration and file session folder. 🚨Please make sure you have `aria2.conf` and `aria2.session` file exist on your host, when yout mount /app/conf. For the first time `aria2.session` just need to be a empty file can be appended. You can also user the templates for these two file in the `conf` folder of this project. Please put your `rclone.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/conf/aria2.conf` | See description above👆🏼 |
|
|
|
|
|
|`/app/conf/aria2.session` | See description above👆🏼 |
|
|
|
|
|
|`/app/conf/rclone.conf` | See description above👆🏼 |
|
|
|
|
@@ -160,6 +164,18 @@ Make sure you have added proper `A` record point to the host you running to your
|
|
|
|
|
```bash
|
|
|
|
|
docker run -d --name aria2-ui -p 80:80 -p 443:443 -e DOMAIN=https://toozhao.com wahyd4/aria2-ui
|
|
|
|
|
```
|
|
|
|
|
## Download Automation 🤖
|
|
|
|
|
|
|
|
|
|
### Download file through iPhone/Mac Shortcuts app.
|
|
|
|
|
|
|
|
|
|
First [Download Shortcut](https://www.icloud.com/shortcuts/7483b8cec7484c0f98b72882d0f1e3e2), then follow the promots to setup aria2-ui URL and RPC_SECRET. Then you are all ready to go, just to run the shortcut and provide the file URL which you want to download or the magnet/torrent file URL.
|
|
|
|
|
|
|
|
|
|
### Download file through cURL
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
curl http://<ip>:<port>/jsonrpc -d "{\"jsonrcp\":\"2.0\",\"id\":\"someID\",\"method\":\"aria2.addUri\",\"params\":[\"token:someToken\",[\"http://some_file_url\"],{\"dir\":\"/data/downloads\"}]}"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Build the image by yourself
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
@@ -191,3 +207,4 @@ I couldn't tell you how to run it in Kubernetes step by step, but once you have
|
|
|
|
|
2. 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.
|
|
|
|
|
3. If you see any errors related to `setcap` which probably means the Linux you are running doesn't support running this application with `non-root` user. So please specify the `PUID` and `PGID` to `0` explicitly to use `root` user to run it.
|
|
|
|
|
4. 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](https://rclone.org/remote_setup) or this [issue](https://github.com/wahyd4/aria2-ariang-docker/issues/118)
|
|
|
|
|
5. Why the app stopped working when I have `- v /<some-folder>:/app/conf` mounted. It happens when you mount the entire `/app/conf` folder but you don't have any files under that folder on your host. To fix this issue, please simply copy all files under [`conf`](https://github.com/wahyd4/aria2-ariang-docker/tree/master/conf) folder to your local folder that you mount to `/app/conf` and then rerun the container.
|
|
|
|
|