Skip to content
This repository has been archived by the owner on Feb 4, 2023. It is now read-only.
/ puddle Public archive

A modern react based frontend for transmission 💧

License

Notifications You must be signed in to change notification settings

mohkale/puddle

Repository files navigation

header

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

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:

Screenshots

screenshot

Dashboard

screenshot

Torrent Files

screenshot

Add torrents from files

screenshot

Add torrents from Magnet Links

screenshot

Statistics

screenshot

Notifications