diff --git a/INSTALL.txt b/INSTALL.txt
index 878abe94b684f9e8454c8da19b4dc7b966e3e5a3..f0d4eaa8416811aff7dd802ebb80635b5c23bdeb 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.txt
Testing the Software
--------------------
-Run "python -c 'import tests;tests.go()'" and make sure there's no errors.
+Run "python -c 'import test;test.go()'" and make sure there's no errors.
If there are errors, please let us know!
Installing the Software
-----------------------
-1. "./setup.py install"
-2. At present, the programs aren't installed, so you will need to copy:
- roundup-admin
- roundup-mailgw
- roundup-server
- to /usr/local/bin if you wish to have them installed.
+1. Run:
+
+ python setup.py install
+
+ If you would prefer the scripts installed in somewhere other than
+ /usr/local/bin, add "--install-scripts=<dir>" to the command:
+
+ python setup.py install --install-scripts=<dir>
+
+ The command:
+
+ python setup.py install --help
+
+ gives all the options available for installation.
Initial Setup
=============
+The following instructions assume that you have installed roundup. If you
+haven't, you may still proceed - just preface all commands with "./"
+ie. "./roundup-admin init".
+
+
Instance
--------
-Try "./roundup-admin init" :)
+Run "roundup-admin init". This initialises a roundup instance.
Roundup is configurable using a localconfig.py file in the instance home.
It may have the following variable declarations:
roundup-admin@MAIL_DOMAIN - roundup's internal use (problems, etc)
+Note:
+We run the instance as group "issue_tracker" and add the mail and web user
+("mail" and "apache" on our RedHat 7.1 system) to that group, as well as
+any admin people.
+
+
Mail
----
Set up a mail alias called "issue_tracker" as:
- "|/usr/bin/python /home/httpd/html/roundup/roundup-mailgw <instance_home>"
+ "|/usr/bin/python /usr/local/bin/roundup-mailgw <instance_home>"
In some installations (e.g. RedHat 6.2 I think) you'll need to set up smrsh
so sendmail will accept the pipe command. In that case, symlink
-/etc/smrsh/python to /usr/bin/python and change the command to:
- "|python /home/httpd/html/roundup/roundup-mailgw <instance_home>"
+/etc/smrsh/roundup-mailgw to /usr/local/bin/roundup-mailgw and change the
+command to:
+ "|roundup-mailgw <instance_home>"
+
+To test the mail gateway on unix systems, try:
+
+ echo test |mail -s '[issue] test' issue_tracker@your.domain
+
Web Interface
Stand-alone:
1. Edit roundup-server at the top - ROUNDUP_INSTANCE_HOMES needs to know
about your instance.
- 2. "./roundup-server [hostname port]" (hostname may be "")
- 3. Load up the page "/" using the port number you set.
+ 2. "roundup-server [hostname port]" (hostname may be "")
+ 3. Load up the page "/<instance name>/index" where instance name is the
+ name you nominated in ROUNDUP_INSTANCE_HOMES.
Apache:
1. Make sure roundup.cgi is executable. Edit it at the top -
------8<------- snip here ------8<-------
note: the RewriteRule must be on one line - no breaks
4. Re-start your apache to re-load the config
- 5. Load up the page "/roundup/roundup.cgi/"
+ 5. Load up the page "/roundup/roundup.cgi/<instance name>/index" where
+ instance name is the name you nominated in ROUNDUP_INSTANCE_HOMES.