== Backlog

Welcome to Backlog!

Backlog is a tool to help you collect and organize all your tasks,
whether you are a single person or a small or large group.

A time keeping module is also included to track time spent on the different tasks.

You can find the Backlog project page at

http://rubyforge.org/projects/backlog/
 

=== Backlog is not meant to be

* an issue tracker with customer communication.
* an invoicing system.

=== Integration

There are concrete plans to integrate Backlog to a few types of systems:

* Issue tracking (Jira, RuyForge, SourceForge, Bugzilla, etc.)
* Calendars (ICal, Outlook, http://icalendar.rubyforge.org/)
* Timekeeping
* Invoicing

If you have concrete needs, and are willing to beta test the integration, please contact us.

=== Installation

* Install ruby
* Install RubyGems
* Install PostgreSQL (or other database management system)
* Install ImageMagick or GraphicsMagick (only required if you want graphs)
* run <tt>sudo gem install backlog -y</tt>
* run <tt>sudo backlog setup_unix</tt>
* run <tt>sudo backlog start</tt>

=== Updates

* run <tt>sudo gem update -y</tt>
* run <tt>sudo backlog setup_unix</tt>
* run <tt>sudo backlog restart</tt>

=== Configuration

You can set configuration parameters for backlog using the /etc/backlog.conf file on unix and "c:\documents and settings\all\backlog.conf" on windows.
The format is YAML.

Example:

port: 3000

database:
  adapter: postgresql
  database: backlog_production
  username: root
  password: verySecret42
  host: localhost
  
=== Charts

The charts in Backlog are made using Gruff (http://nubyonrails.com/pages/gruff).
Gruff uses RMagick (http://rmagick.rubyforge.org/) for image generation.
RMagick uses ImageMagic (http://www.imagemagick.org/script/download.php)
or GraphicsMagic (http://www.graphicsmagick.org/www/download.html).
On some platforms ImageMagick and GraphicsMagick are either not available, or difficult to install.
In that case, RMagick will fail to install, causing the Backlog gem to fail to install.
To bypass this, you can install the Backlog gem using the --ignore-dependencies flag.
Backlog will still work without RMagick, but charts will not be available.


==== Links to charts

You can display the charts directly using links like the ones below.
The charts are normally not protected, so you can display the in slide shows etc. without having to log in.

Examples:

  http://backlog.kubosch.no/periods/burn_down_chart/55.png
  http://backlog.kubosch.no/parties/burn_down_chart/14.png

==== Chart thumbnails

You can get small versions of the burn down charts by appending "_thumbnail" to the URL.

Examples:

http://backlog.kubosch.no/periods/burn_down_chart_thumbnail/55.png
http://backlog.kubosch.no/parties/burn_down_chart_thumbnail/14.png

==== Large charts

You can get large versions (1368x768) of the burn down charts by appending "_large" to the URL.

Examples:

  http://backlog.kubosch.no/periods/burn_down_chart_large/55.png
  http://backlog.kubosch.no/parties/burn_down_chart_large/14.png