tazbug annotate README @ rev 0

Initial commit with the README
author Christophe Lincoln <pankso@slitaz.org>
date Tue Apr 03 11:38:28 2012 +0200 (2012-04-03)
parents
children 8ec78f34725f
rev   line source
pankso@0 1 TazBug - The SliTaz Bug Tracker
pankso@0 2 ================================================================================
pankso@0 3
pankso@0 4
pankso@0 5 The SliTaz Project have setup and tried several bug trackers but ther wher never
pankso@0 6 adopted by the main developers. This is an attemp to change that by providong
pankso@0 7 a radicaly simple tool well integrated wirh SliTaz packages Cooker, Cookiso,
pankso@0 8 Roadmap and other sites such as the wiki and forum.
pankso@0 9
pankso@0 10 Users data are securely stored outside of the web server document root. Password
pankso@0 11 are crypted with MD5 and also stored outside of the document root. Your ID key
pankso@0 12 is the MD5 sum of your login, mail and password
pankso@0 13
pankso@0 14 TazBug is simple to use, 2 type of status exist: OPEN and CLOSED and 4 priority
pankso@0 15 level are handled. Affected packages name can be added to the bug and the all
pankso@0 16 bug configuration file can be edited.
pankso@0 17
pankso@0 18
pankso@0 19 TazBug Goals
pankso@0 20 ------------
pankso@0 21
pankso@0 22 * Simple to use with a clean and modern interface
pankso@0 23 * Client side cmdline tool to post bugs and messages
pankso@0 24 * Full desktop integration with GTK boxes or local CGI script
pankso@0 25 * Use http://paste.slitaz.org/ for attached files
pankso@0 26 * Use shared accounts with other sites to have only one login
pankso@0 27
pankso@0 28
pankso@0 29 Installation
pankso@0 30 ------------
pankso@0 31 TazBug should work on any SliTaz system and can be used as a Bug Tracker for
pankso@0 32 your project. You can grab last source from SliTaz Mercurial repositories or
pankso@0 33 a release tarball from SliTaz mirrors. You need a web server with CGI support
pankso@0 34 and SliTaz httphelp in /usr/lib/slitaz as well as Busybox HTTPd applet.
pankso@0 35
pankso@0 36 People config files: /var/lib/slitaz/people
pankso@0 37 Auth file with pass: /var/lib/slitaz/auth/people
pankso@0 38
pankso@0 39
pankso@0 40 Developement
pankso@0 41 ------------
pankso@0 42 Shell scripts as usual, HTML 5, CSS 3 and a bit of Javascript. To work on bugs
pankso@0 43 locally you have to clone the repo, create a vhost for the web interface and
pankso@0 44 modify tazbug.conf to match your installation. You must also edit /etc/hosts
pankso@0 45 to add your vhost.
pankso@0 46
pankso@0 47
pankso@0 48 ================================================================================
pankso@0 49