Koï - BitTorrent for my girlfriend
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
proxy
public
.gitignore
.gitmodules
README.md
app.json.sample
bower.json
index.js
package.json

README.md

Koï - BitTorrent for my girlfirend

Koi is a tiny Express.js app that wraps the 2 most common uses of a bitTorrent client:

  • Add torrent files to your client
  • Download files when they're ready

Requirements

  • A BitTorrent client (be it Deluge, Transmission, or whatever), watching a specific folder for .torrent files.
  • node v0.10.x

What Koi specifically does is:

  • Upload files to the watched folder
  • Displays the contents of the download folder, and let you navigate into it

Installation

$ git clone https://github.com/xcambar/koi
$ cd koi
$ npm install
$ cp app.json.sample app.json
$ $EDITOR app.json

Configuration

The file app.json configures the app. It contains the following keys:

  • downloadFrom: the root directory you want to traverse via the interface
  • uploadTo: Where the uploaded files should be saved.
  • port: the port the app will listen to. Defaults to 8000

Start the server

Basically, you can start the server as follows:

$ npm start

Then just point your (modern) browser to the URL where the app runs. If you're running on localhost with the default port, head to http://localhost:8000.

You will probably prefer to install it as a service and run it as a specific user. I highly recommend to do so, but can't help you out, it depends on your OS and config. Google it!

Why "for my girlfriend" ??

To those who might doubt, this is not sexism! It's just that the project originates from the complaints of my girlfriend having to use overly complicated BitTorrent clients.

I thought I could help her.

Licence

MIT