Skip to content

Instantly share code, notes, and snippets.

@bindiry
Forked from jremus/README.md
Last active Feb 21, 2018
Embed
What would you like to do?
My aria2 configuration and init script for Raspbian.

Description

Installation

File Locations

  • aria2.conf as /etc/aria2.conf
  • aria2.sh as /etc/init.d/aria2
  • aria2_notify_downloaded.py as /opt/aria2-tools/aria2_notify_downloaded.py

Configuration

  1. Adapt aria2.conf to your needs. At least change the following settings:

    • dir
    • save-session and input-file
  2. Create an empty session file aria2.session by executing the following command:

    touch /mnt/hd1/downloads/aria2.session
  3. Test the init script aria2 by executing the following command sequence:

    sudo /etc/init.d/aria2 start
    sudo /etc/init.d/aria2 status
    sudo /etc/init.d/aria2 stop
    sudo /etc/init.d/aria2 status
  4. Install the init script, if the above test succeeded, by executing the following command:

    sudo update-rc.d aria2 defaults
dir=/mnt/hd1/downloads
#file-allocation=falloc
#continue
log-level=notice
#max-connection-per-server=1
#summary-interval=120
#daemon=true
#enable-rpc=true
#rpc-listen-port=6800
rpc-listen-all=true
max-concurrent-downloads=2
save-session=/mnt/hd1/downloads/aria2.session
input-file=/mnt/hd1/downloads/aria2.session
#log=/var/log/aria2.log
disable-ipv6=true
#timeout=60
retry-wait=30
#max-tries=5
#on-download-complete=/opt/aria2-tools/aria2_notify_downloaded.py
#on-download-error=
#on-download-pause=
#on-download-start=
#on-download-stop=
#on-bt-download-complete=
#! /bin/sh
### BEGIN INIT INFO
# Provides: aria2
# Required-Start: $remote_fs $syslog
# Required-Stop: $remote_fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: aria2
# Description: aria2
### END INIT INFO
# Author: Foo Bar <jens.remus@gmx.de>
# PATH should only include /usr/* if it runs after the mountnfs.sh script
PATH=/sbin:/usr/sbin:/bin:/usr/bin
DESC="aria2c RPC service"
NAME=aria2c
DAEMON=/usr/bin/$NAME
DAEMON_ARGS="--daemon=true --enable-rpc --conf-path=/root/.aria2/aria2.conf"
PIDFILE=/var/run/$NAME.pid
SCRIPTNAME=/etc/init.d/$NAME
# Exit if the package is not installed
[ -x "$DAEMON" ] || exit 0
# Read configuration variable file if it is present
[ -r /etc/default/$NAME ] && . /etc/default/$NAME
# Load the VERBOSE setting and other rcS variables
. /lib/init/vars.sh
# Define LSB log_* functions.
# Depend on lsb-base (>= 3.2-14) to ensure that this file is present and status_of_proc is working.
. /lib/lsb/init-functions
#
# Function that starts the daemon/service
#
do_start()
{
# Return
# 0 if daemon has been started
# 1 if daemon was already running
# 2 if daemon could not be started
start-stop-daemon --start --quiet --exec $DAEMON --test > /dev/null \
|| return 1
start-stop-daemon --start --quiet --exec $DAEMON -- \
$DAEMON_ARGS \
|| return 2
# Add code here, if necessary, that waits for the process to be ready
# to handle requests from services started subsequently which depend
# on this one. As a last resort, sleep for some time.
}
#
# Function that stops the daemon/service
#
do_stop()
{
# Return
# 0 if daemon has been stopped
# 1 if daemon was already stopped
# 2 if daemon could not be stopped
# other if a failure occurred
start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --name $NAME
RETVAL="$?"
[ "$RETVAL" = 2 ] && return 2
# Wait for children to finish too if this is a daemon that forks
# and if the daemon is only ever run from this initscript.
# If the above conditions are not satisfied then add some other code
# that waits for the process to drop all resources that could be
# needed by services started subsequently. A last resort is to
# sleep for some time.
start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
[ "$?" = 2 ] && return 2
# Many daemons don't delete their pidfiles when they exit.
rm -f $PIDFILE
return "$RETVAL"
}
#
# Function that sends a SIGHUP to the daemon/service
#
do_reload() {
#
# If the daemon can reload its configuration without
# restarting (for example, when it is sent a SIGHUP),
# then implement that here.
#
start-stop-daemon --stop --signal 1 --quiet --name $NAME
return 0
}
case "$1" in
start)
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
do_start
case "$?" in
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
esac
;;
stop)
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
do_stop
case "$?" in
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
esac
;;
status)
status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
;;
#reload|force-reload)
#
# If do_reload() is not implemented then leave this commented out
# and leave 'force-reload' as an alias for 'restart'.
#
#log_daemon_msg "Reloading $DESC" "$NAME"
#do_reload
#log_end_msg $?
#;;
restart|force-reload)
#
# If the "reload" option is implemented then remove the
# 'force-reload' alias
#
log_daemon_msg "Restarting $DESC" "$NAME"
do_stop
case "$?" in
0|1)
do_start
case "$?" in
0) log_end_msg 0 ;;
1) log_end_msg 1 ;; # Old process is still running
*) log_end_msg 1 ;; # Failed to start
esac
;;
*)
# Failed to stop
log_end_msg 1
;;
esac
;;
*)
#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
exit 3
;;
esac
:
#!/usr/bin/env python
"""Notify that aria2 download is complete.
This implements the --on-download-complete hook interface.
"""
import sys
import os
import argparse
import pushnotify
PROWL_API_KEY = 'prowl-api-key'
def main(options):
"""Main program."""
pnc = pushnotify.get_client('prowl', application='aria2')
pnc.add_key(PROWL_API_KEY)
target_basename = os.path.basename(options.target_file)
event = "Downloaded %s" % (target_basename,)
description = "First file: %s\n" % (options.target_file,)
description += "GID: %s\n" % (options.gid)
description += "Num files: %s\n" % (options.num_files)
description += "\n"
description += "--\n"
description += sys.argv[0]
try:
pnc.notify(description, event, split=False)
except pushnotify.exceptions.ApiKeyError:
pass
return
def get_options():
"""Get options for the script."""
parser = argparse.ArgumentParser(
description="DESCRIPTION",
)
parser.add_argument('gid', help='gid of the download in aria2')
parser.add_argument('num_files', help='number of files')
parser.add_argument('target_file', help='name of first file on filesystem')
options = parser.parse_args()
return options
if __name__ == "__main__":
main(get_options())
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment