Notice: This project is being deprecated on 2023-02-04 because flood now has support for Transmission as a frontend. This was a fun project but it's currently unecessary.

A flood like react based frontend for the transmission bittorrent daemon.

See the video guide on youtube.

Table of Contents

• Puddle
  • Requirements
  • Instructions
  • Configuration
  • Credits
  • Screenshots

Requirements

• Transmission v3.0 (or higher)
• node v12.0 (or higher)

Installation

1. setup user configuration (see configuration).
2. install dependencies npm i
3. build puddle npm build:production
4. start server npm serve:production

Configuration

Puddle is configured using a simple typescript file at ./config.ts. You have two options for how to start customization.

You can either copy config.template.ts to config.ts and start altering the default fields to your liking. Or you can create a new config file and overwrite the default fields:

import { config as defaultConfig, Config } from './config';

export const config: Config = Object.assign(defaultConfig, {
  ...extraOptions
})

The first approach is recommended because it results in smaller bundles, although the second approach avoids any issues if the configuration format changes across newer puddle versions.

For a list of available configuration fields, see the docs.

Credits

puddle takes heavy inspirations from:

• flood
• tremc
• react-transmission
• transmission-web

Screenshots

Dashboard	Torrent Files
Add torrents from files	Add torrents from Magnet Links
Statistics	Notifications