tazbug annotate README @ rev 17

Tiny edits
author Paul Issott <paul@slitaz.org>
date Tue Apr 03 22:50:25 2012 +0100 (2012-04-03)
parents 8ec78f34725f
children a39c2f6e7317
rev   line source
pankso@0 1 TazBug - The SliTaz Bug Tracker
pankso@0 2 ================================================================================
pankso@0 3
pankso@0 4
paul@17 5 The SliTaz Project have setup and tried several bug trackers but they were never
paul@17 6 adopted by the main developers. This is an attempt to change that by providing
paul@17 7 a radically simple tool well integrated with the SliTaz packages Cooker, Cookiso,
pankso@0 8 Roadmap and other sites such as the wiki and forum.
pankso@0 9
paul@17 10 Users data are securely stored outside of the web server document root. Passwords
pankso@0 11 are crypted with MD5 and also stored outside of the document root. Your ID key
paul@17 12 is the MD5 sum of your login, mail and password.
pankso@0 13
paul@17 14 TazBug is simple to use, 2 types of status exists: OPEN and CLOSED and 2 priority
paul@17 15 levels are handled. Affected packages names can be added to the bug and the all
paul@17 16 bug configuration files 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
paul@17 25 * Use http://paste.slitaz.org/ for attaching files
pankso@0 26 * Use shared accounts with other sites to have only one login
pankso@0 27
pankso@0 28
pankso@2 29 Accounts
pankso@2 30 --------
pankso@2 31 To create an account on SliTaz Bugs you must use the graphical box from
pankso@2 32 your SliTaz system and found in the menu "Network" --> "SliTaz bug report"
pankso@2 33 You can also use the command line tool tazbug with the signup command:
pankso@2 34
pankso@2 35 $ tazbug signup --name="Real Name" --user=login --mail=mail@domain --pass=pass
pankso@2 36
pankso@2 37
pankso@0 38 Installation
pankso@0 39 ------------
pankso@0 40 TazBug should work on any SliTaz system and can be used as a Bug Tracker for
paul@17 41 your project. You can grab last sources from SliTaz Mercurial repositories or
pankso@0 42 a release tarball from SliTaz mirrors. You need a web server with CGI support
pankso@2 43 and SliTaz httphelper in /usr/lib/slitaz as well as Busybox HTTPd applet.
pankso@0 44
pankso@0 45 People config files: /var/lib/slitaz/people
pankso@0 46 Auth file with pass: /var/lib/slitaz/auth/people
pankso@0 47
pankso@0 48
pankso@0 49 Developement
pankso@0 50 ------------
pankso@0 51 Shell scripts as usual, HTML 5, CSS 3 and a bit of Javascript. To work on bugs
pankso@0 52 locally you have to clone the repo, create a vhost for the web interface and
pankso@0 53 modify tazbug.conf to match your installation. You must also edit /etc/hosts
pankso@0 54 to add your vhost.
pankso@0 55
pankso@0 56
pankso@0 57 ================================================================================
pankso@0 58