https://github.com/jeffwilliams/quartz-flow

Web-based torrent client
https://github.com/jeffwilliams/quartz-flow

Last synced: 11 days ago
JSON representation

Web-based torrent client

• Host: GitHub
• URL: https://github.com/jeffwilliams/quartz-flow
• Owner: jeffwilliams
• License: mit
• Created: 2013-10-14T21:08:42.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-05-14T02:54:54.000Z (over 9 years ago)
• Last Synced: 2024-10-31T14:58:08.177Z (16 days ago)
• Language: Ruby
• Size: 604 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
QuartzFlow -- A Web-based Bittorrent Client

===========================================

[![Gem Version](https://badge.fury.io/rb/quartz_flow.png)](http://badge.fury.io/rb/quartz\_flow)

A Web-based Bittorrent client.

QuartzFlow runs as a standalone application which contains a web-server. For those familiar with ruby, it uses Sinatra

to run as a webserver.

QuartzFlow requires ruby 1.9 or greater.

Installation

------------

`gem install quartz_flow`

Running

-------

### Quick Start

  1. Make a directory owned by the current user where you want QuartzFlow to run.

  2. Run `quartzflow setup` to set up the current directory.

  3. Run `quartzflow adduser --login someone` to add a user named `someone` (replace someone with a good username).

  4. Run `quartzflow start` or just `quartzflow` to run QuartzFlow.

  5. Open `localhost:4445/` with your browser and log in.

  6. When finished use CTRL-C to exit.

  7. (Optional) Edit `etc/quartz.rb` and change settings if desired. Restart after changes.

### Details

QuartzFlow expects to be run in a special "home" directory. This is a regular directory that has

had `quartzflow setup` run in it; that is, the command is run with the current directory being the directory to set up.

This setup creates the necessary environment needed for QuartzTorrent to run. It creates the required subdirectories,

copies the HTML templates, creates an empty settings database, and creates default settings files.

This setup only needs to be performed once per home, and from then on QuartzTorrent can

be launched from that directory.

A successfully setup QuartzTorrent home directory contains the following:

`etc/`

Static settings. These are things like what port to listen on, and how to log messages.

`db/`

Dynamic settings. Under this directory is a SQLite database used to store settings that can be changed

through the webpage.

`log/`

Logs. By default, logs about torrent downloading and uploading are written here.

`public/, views/`

Web files. These are the HTML templates, Javascript files, and CSS served when the app is running.

`meta/`

Torrent metainformation. This is where downloaded and uploaded .torrent files are stored, and where Magnet

links are persisted.

`download/`

Downloaded Torrents. By default, downloaded torrent data is written to this directory.

Use the command `quartzflow help` to get help for the various commands.

`plugins/`

Active quartzflow plugins.

### Development Setup

The development setup does not use the released gem, rather the current git repository.

1.  Clone this repository and cd into it

3. `bundle` to download neccessary gems

2. `bundle exec quartzflow setup`, to create neccessary files, they will be ignored by git

4. `bundle exec quartzflow` to start server

So basically after the first bundle the instructions are the same, you just need to prefix commands

with "bundle exec" to use the git versions instead of the gem.