go-transmission-stats/README.md
2023-03-25 18:24:07 -05:00

1.7 KiB

go-transmission-stats

Get stats from a remote Transmission instance using the Transmission RPC API, and output the stats into a HTML document using Go's html/template library.

For other people using this, change the stylesheet in template.html to your preferred one. Also edit the following for your remote Transmission instance:

export RPC_HOST="<ip address of Transmission server>"
export RPC_USER="<rpc username>"
export RPC_PASSWORD="<rpc password>"

My personal use case for this involves running the Go binary go-transmission-stats on a systemd timer that triggers the corresponding service every 12 hours.

First build the binary:

git clone https://codeberg.org/hyperreal/go-transmission-stats
cd go-transmission-stats
go build

Move the binary to a location in PATH:

sudo mv go-transmission-stats /usr/local/bin/

Create the systemd service:

[Unit]
Description=go-transmission-stats service

[Service]
Type=oneshot
ExecStart=sh -c '/usr/local/bin/go-transmission-stats > /home/user/public/html/torrentstats.html'
User=<your user>
Group=<your user's group>
WorkingDirectory=/home/user/go-transmission-stats
ENVIRONMENT="RPC_HOST=<ip address of Transmission server>"
ENVIRONMENT="RPC_USER=<rpc username>"
ENVIRONMENT="RPC_PASSWORD=<rpc password>"

Create the systemd timer:

[Unit]
Description=go-transmission-stats timer

[Timer]
OnCalendar=00/12:00

[Install]
WantedBy=default.target

Move the files to systemd directory and enable the systemd timer:

sudo mv go-transmission-stats.service go-transmission-stats.timer /etc/systemd/system/
sudo systemctl enable --now go-transmission-stats.timer