binhex-ariang
Docker app from Binhex's Repository
Overview
Readme
View on GitHubApplication
Description
AriaNg is a modern web frontend making aria2 easier to use. AriaNg is written in pure html & javascript, thus it does not need any compilers or runtime environment. You can just put AriaNg in your web server and open it in your browser. AriaNg uses responsive layout, and supports any desktop or mobile devices.
Build notes
Latest commit to GitHub branch 'master'.
Usage
docker run -d \
--name=<container name> \
-p <host port for ariang>:8127 \
-p <host port for aria>:6800 \
-v <path for config files>:/config \
-v <path for data files>:/data \
-v /etc/localtime:/etc/localtime:ro \
-e TZ=Etc/<region> \
-e ARIA2_RPC_SECRET=<rpc secret token> \
-e ENABLE_STARTUP_SCRIPTS=<yes|no> \
-e STARTUP_SCRIPTS_MODE=<wait|parallel> \
-e HEALTHCHECK_COMMAND=<command> \
-e HEALTHCHECK_ACTION=<action> \
-e HEALTHCHECK_HOSTNAME=<hostname> \
-e UMASK=<umask for created files> \
-e PUID=<uid for user> \
-e PGID=<gid for user> \
binhex/arch-ariang
Please replace all user variables in the above command defined by <> with the correct values.
Access AriaNg Web UI
http://<host ip>:8127
Aria2 RPC Credentials
AriaNg has no login of its own, access to aria2 is controlled by the JSON-RPC
secret token. If ARIA2_RPC_SECRET is not set and no secret file exists then a
32 character secret is generated on start and stored in
/config/aria2/secrets/rpc-secret, the same secret is reused on every restart.
To connect, open AriaNg, go to Settings -> RPC, set the host to your unRAID
host IP, the port to 6800 and paste the secret into Secret token.
A rpc-secret already set in /config/aria2/configs/aria2.conf is used as-is
and no secret file is generated.
Example
docker run -d \
--name=ariang \
-p 8127:8127 \
-p 6800:6800 \
-v /apps/docker/ariang/config:/config \
-v /apps/docker/ariang/data:/data \
-v /etc/localtime:/etc/localtime:ro \
-e TZ=Etc/UTC \
-e ENABLE_STARTUP_SCRIPTS=no \
-e STARTUP_SCRIPTS_MODE=wait \
-e UMASK=000 \
-e PUID=99 \
-e PGID=100 \
binhex/arch-ariang
Notes
ARIA2_RPC_SECRET sets the aria2 JSON-RPC secret token, it takes precedence
over a secret stored in /config/aria2/secrets/rpc-secret and any
rpc-secret set in /config/aria2/configs/aria2.conf.
/data is available as a download location, aria2 writes to
/config/aria2/downloads by default, change the dir option in
/config/aria2/configs/aria2.conf to use /data instead.
ENABLE_STARTUP_SCRIPTS when set to yes (default no) will allow a user to
install additional packages from the official Arch Repository or the Arch User
Repository (AUR) via scripts located in the folder /config/ariang/scripts/.
STARTUP_SCRIPTS_MODE controls how those scripts are executed, set to wait
(default) to run each script in turn and wait for it to complete before the next
script runs, or parallel to run all scripts at the same time.
User ID (PUID) and Group ID (PGID) can be found by issuing the following command for the user you want to run the container as:-
id <username>
If you appreciate my work, then please consider buying me a beer :D
Requirements
Aria2 RPC authentication
AriaNg has no login of its own, the aria2 JSON-RPC port (6800) is secured with a secret token. ARIA2_RPC_SECRET overrides a secret stored in /config/aria2/secrets/rpc-secret or a secret set in /config/aria2/configs/aria2.conf. If none is set then a secret is generated on start and stored in /config/aria2/secrets/rpc-secret, and the same secret is reused on restart. Open AriaNg, go to Settings -> RPC, set the host to your unRAID IP, the port to 6800 and paste the secret into 'Secret token'.
Downloads
aria2 saves downloads to /config/aria2/downloads by default. To use the /data mapping, change the 'dir' option in /config/aria2/configs/aria2.conf.
Categories
Download Statistics
Related apps
Explore more like this
Explore allDetails
ghcr.io/binhex/arch-ariangRuntime arguments
- Web UI
http://[IP]:[PORT:8127]- Network
bridge- Shell
bash- Privileged
- false
- Extra Params
--restart=unless-stopped
Template configuration
This is the Web UI port for the application.
- Target
- 8127
- Default
- 8127
This is the aria2 JSON-RPC port used by AriaNg to control aria2.
- Target
- 6800
- Default
- 6800
This is the container path to your configuration files, e.g. databases, configuration files, logs etc.
- Target
- /config
- Default
- /mnt/user/appdata/ariang
This is the container path to your downloaded files or user created content.
- Target
- /data
Specify the timezone.
- Target
- TZ
- Default
- Etc/UTC
Secret token for the aria2 JSON-RPC interface, enter it in AriaNg under Settings -> RPC. Overrides a secret stored in /config/aria2/secrets/rpc-secret or set in /config/aria2/configs/aria2.conf. If left empty and no secret is stored, one is generated on start.
- Target
- ARIA2_RPC_SECRET
Specify whether to run startup scripts to install and/or configure additional applications.
- Target
- ENABLE_STARTUP_SCRIPTS
- Default
- no|yes
Specify whether to run the startup scripts sequentially, waiting for each script to complete, or in parallel.
- Target
- STARTUP_SCRIPTS_MODE
- Default
- wait|parallel
Enable or disable healthchecks.
- Target
- ENABLE_HEALTHCHECK
- Default
- yes|no
The command or script to execute, if not specified then the script healthcheck.sh will be used (process, dns and https checking).
- Target
- HEALTHCHECK_COMMAND
The action to execute if the healthcheck command returns a non zero exit code, if not specified the action will be 'exit 1', if you want the container to exit on failure then set the action to 'kill 1'.
- Target
- HEALTHCHECK_ACTION
The hostname used when performing HTTPS and DNS healthchecking.
- Target
- HEALTHCHECK_HOSTNAME
- Default
- google.com
User ID for the running container
- Target
- PUID
- Default
- 99
Group ID for the running container
- Target
- PGID
- Default
- 100
UMASK for the running container
- Target
- UMASK
- Default
- 000