Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A BitTorrent tracker written in Ruby on Rails
Ruby JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
config
db
doc
lib/tasks
public
script
test
vendor/plugins
.gitignore
COPYING
Gemfile
Gemfile.lock
README.textile
Rakefile
config.ru

README.textile

Blue Sun info

Introduction

Blue Sun is attempt at a feature rich BitTorrent tracker and index in a single Ruby on Rails application. It is still very new, and as such should not be used for anything critical.

The name Blue Sun is inspired by the show Firefly and The Blue Sun Corporation that knows (and is seemingly responsible) for all things bad in the ’verse. This application will be tracking torrents and information about them, so it seemed like a good enough fit.

Purpose

The purpose of Blue Sun is to:

  1. Learn more about the BitTorrent protocol.
  2. Write (from what I can tell) the first public tracker written in Rails.
  3. Hopefully make a popular project for both public and private BitTorrent tracking.

With any luck, I’ll eventually reach all these goals.

Licensing

Blue Sun is available under the GNU General Public License v3:

Copyright 2011 Jonathan Gnagy

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses/.

Installation

To install Blue Sun on Linux / OS X / any other Unix-like OS:

  1. Install JRuby
  2. Install a java app server like Tomcat, Glassfish, Jetty, or most others.
  3. Install Solr (probably in the same app server mentioned in the previous step)
  4. Download the Blue Sun source and install any missing Ruby gems.
    1. `git clone git://github.com/jgnagy/blue-sun.git`
    2. `cd blue-sun; jruby -S bundle install`
  5. You may need to configure the app for your environment. Usually that means modifying:
    1. “config/initializers/devise.rb”
    2. “config/sunspot.yml”
    3. “config/database.yml”
  6. Create the Blue Sun WAR file
    1. `jruby -S rake war`
  7. Create the Blue Sun database (this should be configured in “config/database.yml”):
    1. `jruby -S rake db:migrate RAILS_ENV=production`
  8. Create an environment variable to represent Blue Sun’s home directory (this directory should exist and be owned by the user that your app server runs as):
    1. `export BLUESUN_HOME=/path/to/bluesun/home`
  9. Start your java app server. This varies by app server.
  10. Solr should already be running at this point.
  11. Deploy your newly created WAR file (should be “bluesun.war” under the Blue Sun source directory). This varies by java app server.
  12. Hit your app server’s URL with the context of /bluesun/. (Usually something like “http://servername:8080/bluesun/”)

This process may change as development continues.

Project Status

Currently, Blue Sun does does the following:

  • Allows uploading and downloading torrents (.torrent files)
  • Full-text search for torrent name and description through Solr
  • Looks pretty

As you can see, I still have a long way to go.

Something went wrong with that request. Please try again.