tazbug view README @ rev 78

Tiny edits
author Paul Issott <paul@slitaz.org>
date Wed Feb 05 19:01:00 2014 +0000 (2014-02-05)
parents 02a11d8d636e
children d24cd6951458
line source
1 TazBug - The SliTaz Bug Tracker
2 ================================================================================
5 The SliTaz Project has setup and tried several bug trackers but they were never
6 adopted by the main developers. This is an attempt to change that by providing
7 a radically simple tool well integrated with the SliTaz packages Cooker, Cookiso,
8 Roadmap and other sites such as the wiki and forum.
10 Users data are securely stored outside of the web server document root. Passwords
11 are encrypted with MD5 and also stored outside of the document root. Your ID key
12 is the MD5 sum of your login, mail and password.
14 TazBug is simple to use, 2 types of status exist: OPEN and CLOSED and 2 priority
15 levels are handled. Affected packages names can be added to the bug and all
16 bug configuration files can be edited.
19 TazBug Goals
20 ------------
22 * Simple to use with a clean and modern interface
23 * Client side cmdline tool to post bugs and messages
24 * Full desktop integration with GTK boxes or local CGI script
25 * Use http://paste.slitaz.org/ for attaching files
26 * Use shared accounts with other sites to have only one login
29 Accounts
30 --------
31 To create an account on SliTaz Bugs you must use the graphical box from
32 your SliTaz system found in the menu "Network" --> "SliTaz bug report"
33 You can also use the command line tool tazbug with the signup command:
35 $ tazbug signup --name="Real Name" --user=login --mail=mail@domain --pass=pass
38 Installation
39 ------------
40 TazBug should work on any SliTaz system and can be used as a Bug Tracker for
41 your project. You can grab latest sources from SliTaz Mercurial repositories or
42 a release tarball from SliTaz mirrors. You need a web server with CGI support
43 and SliTaz httphelper in /usr/lib/slitaz as well as Busybox HTTPd applet.
45 People config files: /var/lib/slitaz/people
46 Auth file with pass: /var/lib/slitaz/auth/people
49 Development
50 ------------
51 Shell scripts as usual, HTML 5, CSS 3 and a bit of Javascript. To work on bugs
52 locally you have to clone the repo, create a vhost for the web interface and
53 modify tazbug.conf to match your installation. You must also edit /etc/hosts
54 to add your vhost.
57 ================================================================================