Downspout

Overview

This app helps you sync from a seedbox / torrent machine, where media files are being downloaded, to your HTPC (or whatever destination computer.) It is in two parts. There is a bash script that lives on your seedbox which creates symlinks and then notifies the Node.js app that runs on your HTPC.

Seedbox

This script lives on your seedbox and requires your torrent application to call it. Deploy the ./seedbox folder to your seedbox and configure as below.

Configuration

Create a config.sh file into the same folder as the files you just copied.

#!/usr/bin/env bash

baseMediaDir=~/files/torrent/download/path
# We need a full path, so if you use something like ~, we need to evaluate it.
eval baseMediaDir=$baseMediaDir

# Relative path is ok here.
syncDir="toUpload"

# Where the HTPC Node.js lives
syncServer=http://[some ip address]:45532

Important: syncDir and baseMediaDir need to both be accessible via FTP. And the FTP client must be able to delete files from syncDir.

Make the script files executable

cd seedbox
chmod u+x *.sh

Torrent client setup

Setup the Execute Plugin to call seedbox/deluge.sh on torrent complete.

HTPC

This app lives on your HTPC (Destination server). It's the destination for the sync process. It sits and waits for a ping from the seedbox (or regularly scheduled interval) to scan the seedbox for new files that need to be pulled down.

Configuration

Before running you must setup a config.js file of your own in the root. See Config.ts for more information about the config settings. (You can copy config.sample.js to config.js as a starting point.)

Example:

// our base config derives from the default config object.
const config = require('./src/ts/Config').newConfig();

config.seedboxFtp = {
    host: "my.server",
    user: "someUserName",
    password: "PASSWORD",
    syncRoot: "/seedbox-sync/toUpload",
    pollingIntervalInSeconds: 10
};

// Default destination folder, if no path mappings found, this will be used.
config.localSyncFolder = "C:\\seedboxTest";

// optionally, you can setup path mappings to setup unique destination paths for specific remote paths
config.pathMappings =
    [
        {
            remotePath: "/downspout/toUpload/tv",
            localPath: "c:/seedbox/tv",
            type: "shows"
        },
        {
            remotePath: "/downspout/toUpload/movies",
            localPath: "d:/home-theater/movies",
            type: "movies"
        }
    ];

config.downloads = {
    countMax: 2,
    speedMax: 300000
};

config.port = 45532;

# This app will start deleting stuff from your FTP server. So set this to false when you're testing your config. But it should be set to true when you've confirmed everything is setup ok.
config.deleteRemoteFiles = true;

module.exports = config;

How to run

Standard node start

Do this first to make sure that everything runs ok.

# Install required packages
npm install

# Start the app
npm start

As a service using pm2

This will run the app using pm2 allowing it to run in the background and on system startup.

# Install pm2
sudo npm install pm2 -g

# Have pm2 run at startup as the specified user
sudo pm2 startup -u nodeuser

# Start the app and save the config
pm2 start npm --name "downspout" -- start && pm2 save

# Note, for faster startup times you can skip the TypeScript compilation with this line instead
# pm2 start npm --name "downspout" -- execute && pm2 save