Code

various updates
[roundup.git] / doc / FAQ.txt
index e0b442f692772f3d0e60648a3595411ecdaf4808..a96f9ba7b56913d5360cd3c9c1f54db901d6f245 100644 (file)
@@ -2,9 +2,7 @@
 Roundup FAQ
 ===========
 
-:Version: $Revision: 1.11 $
-
-NOTE: This is just a grabbag, most of this should go into documentation.
+:Version: $Revision: 1.15 $
 
 .. contents::
 
@@ -12,24 +10,157 @@ NOTE: This is just a grabbag, most of this should go into documentation.
 Installation
 ------------
 
-Living without a mailserver.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Living without a mailserver
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Remove the nosy reactor, means delete the tracker file
-'detectors/nosyreactor.py'.
+``detectors/nosyreactor.py`` from your tracker home.
+
+
+The cgi-bin is very slow!
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Yep, it sure is. It has to start up Python and load all of the support
+libraries for *every* request.
+
+The solution is to use the built in server.
+
+To make Roundup more seamless with your website, you may place the built
+in server behind apache and link it into your web tree
+
+
+How do I put Roundup behind Apache
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We have a project (foo) running on ``foohost.com:8888``.
+We want ``http://foohost.com/FooIssues`` to use the roundup server, so we 
+set that up on port 8888 on ``foohost.com`` with the ``config.py`` line::
+
+  TRACKER_WEB = 'http://foohost.com/FooIssues/'
+
+We have a "foo_issues" tracker and we run the server with::
+
+  roundup-server -p 8888 foo_issues=/home/roundup/trackers/foo_issues 
+
+Then, on the Apache machine (eg. redhat 7.3 with apache 1.3), in
+``/etc/httpd/conf/httpd.conf`` uncomment::
+
+  LoadModule proxy_module       modules/libproxy.so
+
+and::
+
+  AddModule mod_proxy.c
+
+Then add::
+
+  # roundup stuff (added manually)
+  <IfModule mod_proxy.c>
+
+  RewriteEngine on
+  
+  # General Roundup
+  RewriteRule ^/Roundup$  Roundup/    [R]
+  RewriteRule ^/Roundup/(.*) http://foohost.com:8888/$1   [P]
+  
+  # Redirect to Foo Issues
+  RewriteRule ^/Roundup/foo_issues(.*) FooIssues$1    [R]
+  
+  # Handle Foo Issues
+  RewriteRule ^/FooIssues$  FooIssues/    [R]
+  RewriteRule ^/FooIssues/(.*) http://foohost.com:8888/foo_issues/$1 [P]
+  
+  </IfModule>
+
+Then restart Apache. Now Apache will proxy the request on to the
+roundup-server.
+
+You need to add the last 3 RewriteRule lines for each tracker that you have.
+
+You can now firewall off port 8888 from the rest of the world.
+
+
+Roundup runs very slowly on my XP machine when accessed from the Internet
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The issue is probably related to host name resolution for the client
+performing the request. You can turn off the resolution of the names
+when it's so slow like this. To do so, edit the module
+roundup/scripts/roundup_server.py around line 77 to add the following
+to the RoundupRequestHandler class:
+
+     def address_string(self):
+         return self.client_address[0]
+
+
+Templates
+---------
+
+What is that stuff in the tracker html directory?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This is the template code that Roundup uses to display the various pages.
+This is based upon the template markup language in Zope called, oddly
+enough "Zope Page Templates". There's documentation in the Roundup
+customisation_ documentation. For more information have a look at:
+
+   http://www.zope.org/Documentation/Books/ZopeBook/current/contents
+
+specifically chapter 5 "Using Zope Page Templates" and chapter 9 "Advanced
+Page Templates".
+
+
+But I just want a select/option list for ....
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Really easy... edit ``html/issue.item``. For 'nosy', change line 53 from::
+
+  <span tal:replace="structure context/nosy/field" />
+
+to::
+
+  <span tal:replace="structure context/nosy/menu" />
+
+For 'assigned to', change line 61 from::
+
+  <td tal:content="structure context/assignedto/field">assignedto menu</td>
+
+to::
+
+  <td tal:content="structure context/assignedto/menu">assignedto menu</td>
+
+
+
+Great! But now the select/option list is too big
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Thats a little harder (but only a little ;^)
+
+Again, edit ``html/issue.item``. For nosy, change line 53 from:
+
+  <span tal:replace="structure context/nosy/field" />
+
+to::
+
+  <span tal:replace="structure python:context.nosy.menu(height=3)" />
+
+for more information, go and read about Zope Page Templates.
+
 
+Using Roundup
+-------------
 
-Rights issues (MISSING)
-~~~~~~~~~~~~~~~~~~~~~~~
+I got an error and I cant reload it!
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Different jobs run under different users.
+If you're using Netscape/Mozilla, try holding shift and pressing reload.
+If you're using IE then install Mozilla and try again ;^)
 
-* Standalone roundup-server is started by whome ?
 
-* Running cgi under apache.
+I keep getting logged out
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
-* roundup-mailgw called via .forward from MTA, or running a cron job
-  fetching via pop.
+Make sure that the TRACKER_WEB setting in your tracker's config.py is set
+to the URL of the tracker.
 
 
 -----------------
@@ -37,4 +168,5 @@ Different jobs run under different users.
 Back to `Table of Contents`_
 
 .. _`Table of Contents`: index.html
+.. _`customisation`: customizing.html