Portainer Templates logo

Portainer Templates

Aria2 Pro Aria2 Pro

Stack

Downloaders

A perfect Aria2 Docker image. Out of the box, just add download tasks and don't need to think about anything else.

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

Aria2-Pro

Configuration

Image
p3terx/aria2-pro
Ports
6800:68006888:68886888:6888/udp
Volumes
/config : /portainer/Files/AppData/Config/aria2-pro/downloads : /portainer/Downloads
Env vars
PUID=65534PGID=65534UMASK_SET=022RPC_PORT=6800LISTEN_PORT=6888DISK_CACHE=64MIPV6_MODE=falseUPDATE_TRACKERS=trueCUSTOM_TRACKER_URL=TZ=Europe/Athens
Restart
always

Image details

Pulls: 11.2M
User: p3terx
Created: Jan 09, 2020
Updated: 12 hours ago
Status: active

AriaNg

Configuration

Image
p3terx/ariang
Command
--port 6880 --ipv6
Ports
6880:6880
Env vars
PUID=1000PGID=1000ARIA2RPCPORT=6800RPC_SECRET=P3TERX
Restart
always

Image details

Pulls: 6.0M
User: p3terx
Created: Jun 09, 2020
Updated: 12 hours ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Aria2 Pro

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Aria2 Pro, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

#https://raw.githubusercontent.com/P3TERX/Aria2-Pro-Docker/master/docker-compose.yml
services:

  Aria2-Pro:
    container_name: aria2-pro
    image: p3terx/aria2-pro
    environment:
      - PUID=65534
      - PGID=65534
      - UMASK_SET=022
      #- RPC_SECRET=P3TERX
      - RPC_PORT=6800
      - LISTEN_PORT=6888
      - DISK_CACHE=64M
      - IPV6_MODE=false
      - UPDATE_TRACKERS=true
      - CUSTOM_TRACKER_URL=
      - TZ=Europe/Athens
    volumes:
      - /portainer/Files/AppData/Config/aria2-pro:/config
      - /portainer/Downloads:/downloads
# If you use host network mode, then no port mapping is required.
# This is the easiest way to use IPv6 networks.
#    network_mode: host
    network_mode: bridge
    ports:
      - 6800:6800
      - 6888:6888
      - 6888:6888/udp
    restart: always
# Since Aria2 will continue to generate logs, limit the log size to 1M to prevent your hard disk from running out of space.
    logging:
      driver: json-file
      options:
        max-size: 1m

# AriaNg is just a static web page, usually you only need to deploy on a single host.
  AriaNg:
    container_name: ariang
    image: p3terx/ariang
    environment:
      - PUID=1000
      - PGID=1000
      - ARIA2RPCPORT=6800
      - RPC_SECRET=P3TERX
    command: --port 6880 --ipv6
#    network_mode: host
    network_mode: bridge
    ports:
      - 6880:6880
    restart: always
    logging:
      driver: json-file
      options:
        max-size: 1m

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/aria2pro.yml up -d

More install options in our documentation.

Container Documentation

Aria2-Pro Documentation

Aria2 Pro | A perfect Aria2 Docker image | The ultra fast download utility

AriaNg Documentation

AriaNg Docker image | A modern web frontend making aria2 easier to use | Aria2 WebUI

Serve Aria2 Pro on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying aria2-pro.example.com to http://Aria2-Pro:6800

Add this to your Caddyfile

aria2-pro.example.com {
	reverse_proxy http://Aria2-Pro:6800
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:6800 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :6800
  • Stop the other service, or pick a different host port. In 6800:6800 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:6800. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, aria2-pro can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 6800

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 65534:65534 /portainer/Files/AppData/Config/aria2-pro (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 65534:65534) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull p3terx/aria2-pro

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The always restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

CUSTOM_TRACKER_URL has no default value, and aria2-pro may crash or misbehave if left empty.

  • Fill it in on the deploy screen before hitting deploy.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Aria2 Pro is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • Aria2-Pro runs p3terx/aria2-pro
  • AriaNg runs p3terx/ariang

Ports

A port is the door the app answers on. A mapping like 6800:6800 means it's reachable on port 6800 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 6800:6800
  • 6888:6888
  • 6888:6888 over UDP
  • 6880:6880

Volumes

A volume is where Aria2 Pro keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /portainer/Files/AppData/Config/aria2-pro on the host
  • /downloads from /portainer/Downloads on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Aria2 Pro takes 12 of them, and one needs a value before it'll start properly:

  • PUID, defaults to 1000
  • PGID, defaults to 1000
  • UMASK_SET, defaults to 022
  • RPC_PORT, defaults to 6800
  • LISTEN_PORT, defaults to 6888
  • DISK_CACHE, defaults to 64M
  • IPV6_MODE, defaults to false
  • UPDATE_TRACKERS, defaults to true
  • CUSTOM_TRACKER_URL, needs a value
  • TZ, defaults to Europe/Athens
  • ARIA2RPCPORT, defaults to 6800
  • RPC_SECRET, defaults to P3TERX

Restart policy

The restart policy here is always, so Docker brings Aria2 Pro back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like Aria2-Pro) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Aria2 Pro up. Add the template list to Portainer once, then deploying Aria2 Pro is a click rather than a wall of config.