Mercurial > p > roundup > code
comparison README @ 52:33bfce110d1e
Fixed the ROUNDUPS decl in roundup-server
Move the installation notes to INSTALL
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Mon, 23 Jul 2001 08:53:44 +0000 |
| parents | 44c274907ecd |
| children |
comparison
equal
deleted
inserted
replaced
| 51:3a7e5515c1bd | 52:33bfce110d1e |
|---|---|
| 9 | 9 |
| 10 The stylesheet included with this package has been copied from the Zope | 10 The stylesheet included with this package has been copied from the Zope |
| 11 management interface and presumably belongs to Digital Creations. | 11 management interface and presumably belongs to Digital Creations. |
| 12 | 12 |
| 13 | 13 |
| 14 TODO: Instructions need re-writing!! | |
| 15 | |
| 16 | |
| 17 2. Installation | 14 2. Installation |
| 18 =============== | 15 =============== |
| 19 These instructions work on redhat 6.2 and mandrake 8.0 - with the caveat | 16 For installation notes, please see the file INSTALL.TXT |
| 20 that these systems don't come with python 2.0 or newer installed, so you'll | |
| 21 have to upgrade python before this stuff will work. | |
| 22 | |
| 23 Roundup is configurable using a localconfig.py file. It may have the | |
| 24 following variable declarations: | |
| 25 | |
| 26 ROUNDUP_HOME - This is the root directory for roundup | |
| 27 MAILHOST - The SMTP mail host that roundup will use to send mail | |
| 28 MAIL_DOMAIN - The domain name used for email addresses | |
| 29 | |
| 30 Any further configuration should be possible by editing config.py directly. | |
| 31 The email addresses used by the system by default are: | |
| 32 | |
| 33 issue_tracker@MAIL_DOMAIN - submissions of issues | |
| 34 roundup-admin@MAIL_DOMAIN - roundup's internal use (problems, etc) | |
| 35 | |
| 36 | |
| 37 2.0 Prerequisites | |
| 38 ----------------- | |
| 39 Either: | |
| 40 . Python 2.0 with pydoc installed. See http://www.lfw.org/ for pydoc. | |
| 41 or | |
| 42 . Python 2.1 | |
| 43 | |
| 44 Both need the bsddb module. | |
| 45 | |
| 46 | |
| 47 2.1 Initial Setup | |
| 48 ----------------- | |
| 49 | |
| 50 | |
| 51 2.2 Mail | |
| 52 -------- | |
| 53 Set up a mail alias called "issue_tracker" as: | |
| 54 "|/usr/bin/python /home/httpd/html/roundup/roundup-mailgw <instance_home>" | |
| 55 | |
| 56 In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh | |
| 57 so sendmail will accept the pipe command. In that case, symlink | |
| 58 /etc/smrsh/python to /usr/bin/python and change the command to: | |
| 59 "|python /home/httpd/html/roundup/roundup-mailgw <instance_home>" | |
| 60 | |
| 61 | |
| 62 2.3 Web Interface | |
| 63 ----------------- | |
| 64 This software will work through apache or stand-alone. | |
| 65 | |
| 66 Stand-alone: | |
| 67 1. Edit server.py at the bottom to set your hostname and a port that is free. | |
| 68 2. "python server.py" | |
| 69 3. Load up the page "/" using the port number you set. | |
| 70 | |
| 71 Apache: | |
| 72 1. Make sure roundup.cgi is executable | |
| 73 2. Edit your /etc/httpd/conf/httpd.conf and make sure that the | |
| 74 /home/httpd/html/roundup/roundup.cgi script will be treated as a CGI | |
| 75 script. | |
| 76 3. Add the following to your /etc/httpd/conf/httpd.conf: | |
| 77 ------8<------- snip here ------8<------- | |
| 78 RewriteEngine on | |
| 79 RewriteCond %{HTTP:Authorization} ^(.*) | |
| 80 RewriteRule ^/roundup/roundup.cgi(.*) /home/httpd/html/roundup/roundup.cgi$1 [e=HTTP_CGI_AUTHORIZATION:%1,t=application/x-httpd-cgi,l] | |
| 81 ------8<------- snip here ------8<------- | |
| 82 note: the RewriteRule must be on one line - no breaks | |
| 83 4. Re-start your apache to re-load the config | |
| 84 5. Load up the page "/roundup/roundup.cgi/" | |
| 85 | |
| 86 | 17 |
| 87 | 18 |
| 88 3. Usage | 19 3. Usage |
| 89 ======== | 20 ======== |
| 90 The system is designed to accessed through the command-line, e-mail or web | 21 The system is designed to accessed through the command-line, e-mail or web |
| 91 interface. | 22 interface. |
| 92 | 23 |
| 93 3.1 Command-line | 24 3.1 Command-line |
| 94 ---------------- | 25 ---------------- |
| 95 The command-line tool is called "roundup.py" and is used for most low-level | 26 The command-line tool is called "roundup-admin" and is used for most low-level |
| 96 database manipulations such as: | 27 database manipulations such as: |
| 28 . creating a database instance | |
| 97 . redefining the list of products ("create" and "retire" commands) | 29 . redefining the list of products ("create" and "retire" commands) |
| 98 . adding users manually, or setting their passwords ("create" and "set") | 30 . adding users manually, or setting their passwords ("create" and "set") |
| 99 . other stuff - run it with no arguments to get a better description of | 31 . other stuff - run it with no arguments to get a better description of |
| 100 what it does. | 32 what it does. |
| 101 | 33 |
| 102 | 34 |
| 103 3.2 E-mail | 35 3.2 E-mail |
| 104 ---------- | 36 ---------- |
| 105 See the docstring at the start of the roundup-mailgw.py source file. | 37 See the docstring at the start of the roundup/mailgw.py source file. |
| 106 | 38 |
| 107 | 39 |
| 108 3.3 Web | 40 3.3 Web |
| 109 ------- | 41 ------- |
| 110 Hopefully, this interface is pretty self-explanatory... | 42 Hopefully, this interface is pretty self-explanatory... |
| 218 | 150 |
| 219 7. Thanks | 151 7. Thanks |
| 220 ========= | 152 ========= |
| 221 Well, Ping, of course ;) | 153 Well, Ping, of course ;) |
| 222 | 154 |
| 223 Anthony Baxter, for some good first-release feedback. | 155 Anthony Baxter, for some good first-release feedback. And then continuing |
| 156 support through development on sourceforge. | |
| 224 | 157 |