http://github.com/DatekWireless/backlog/raw/master/Screenshot.png

== 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://github.com/DatekWireless/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/)

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

=== Installation

==== Gem

* Install ruby
* Install RubyGems
* Install PostgreSQL (or other database management system)
* run <tt>sudo gem install backlog</tt>
* run <tt>sudo backlog setup_unix</tt>
* run <tt>sudo backlog start</tt>

===== Charts

* Install ImageMagick
* run <tt>sudo gem install rmagick</tt>

===== Updates

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

==== War

* Install ImageMagick (only required if you want graphs)
* Install Java (Standard Edition, version 6 or later)
* Install a Java application server (file a support request at http://rubyforge.org/projects/backlog if you need help).
* Pop the backlog.war file into it



=== Configuration

==== Setting port

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


==== Setting database connection parameters

You can set database connnection parameters using the /etc/backlog/config/database.yml file on unix
and "c:\documents and settings\all\backlog\config\database.yml" on windows.
The format is YAML.

Example:

development:
adapter: postgresql
database: backlog_development
username: root
password: verySecret42
host: localhost

production:
adapter: postgresql
database: backlog_production
username: root
password: verySecret42
host: localhost

See the Rails documentation (http://rubyonrails.org) for more documentation on the databse connection seetings.

=== 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/64.png
http://backlog.kubosch.no/parties/burn_down_chart/1.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/64.png
http://backlog.kubosch.no/parties/burn_down_chart_thumbnail/1.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/64.png
http://backlog.kubosch.no/parties/burn_down_chart_large/1.png