Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/adoyle-h/aria2-in-container

A lightweight docker image to run aria2 and AriaNG. Out Of The Box.
https://github.com/adoyle-h/aria2-in-container

aria aria2 container docker image

Last synced: 14 days ago
JSON representation

A lightweight docker image to run aria2 and AriaNG. Out Of The Box.

Awesome Lists containing this project

README

        

# aria2 in container

A lightweight docker image to run [aria2](https://github.com/aria2/aria2) and [AriaNG](https://github.com/mayswind/AriaNg).

https://hub.docker.com/r/adoyle/aria2

## Features

- Out Of The Box. Zero config.
- Web UI.
- Running in container.
- The compose.yaml file provided.
- lightweight image. About 10MB.
- Support multi OS/Arch: linux/amd64, linux/arm64, linux/386, linux/arm/v7, linux/arm/v6

## Usages

### Quick Start

```sh
wget https://raw.githubusercontent.com/adoyle-h/aria2-docker/main/compose.yaml
docker compose up -d
```

To visit http://localhost:8080/ in browser.

## The .env file

See https://docs.docker.com/compose/environment-variables/set-environment-variables/

Example:

```sh
cat < .env
IMAGE_VERSION=1.1.0
DOWNLOAD_DIR=./downloads
WEB_PORT=8080
RPC_PORT=6800
EOF
```

## Config

1. Create your aria2.conf file.
2. Edit volumes in compose.yaml.

```diff
services:
aria2:
image: adoyle/aria2:${IMAGE_VERSION:-1.1.0}
container_name: aria2
volumes:
- ${DOWNLOAD_DIR:-./downloads}:/root/downloads
+ - ./aria2.conf:/etc/aria2.conf
ports:
- ${WEB_PORT:-8080}:80
- ${RPC_PORT:-6800}:6800
```

## Logs

No logs to container stdout/stderr. The logs output to below files:

- /root/start.log
- /var/log/aria2.log
- /var/log/mini_httpd/*.log
- /var/log/rc.log

## Debug

### Change log level of aria2

```sh
docker exec -it aria2 ash
# change the option: log-level
vi /etc/aria2.conf
rc-service aria2 restart
tail -f /var/log/aria2.log
```

## Build image from source

```sh
git clone https://github.com/adoyle-h/aria2-docker.git
cd aria2-docker
make build
```

## Development

First, install `task` command. See https://taskfile.dev/installation/

### Update bt-tracker

`task update-tracker`

### Build and push multi-arch images

`task buildx -- $version`

## Suggestion, Bug Reporting, Contributing

**Before opening new Issue/Discussion/PR and posting any comments**, please read [Contributing Guidelines](https://gcg.adoyle.me/CONTRIBUTING).

## Copyright and License

Copyright 2023-2024 ADoyle ([email protected]). Some Rights Reserved.
The project is licensed under the **Apache License Version 2.0**.

See the [LICENSE][] file for the specific language governing permissions and limitations under the License.

See the [NOTICE][] file distributed with this work for additional information regarding copyright ownership.

[LICENSE]: ./LICENSE
[NOTICE]: ./NOTICE
[tags]: https://github.com/adoyle-h/aria2-docker/tags
[issue]: https://github.com/adoyle-h/aria2-docker/issues