===========
Roundup FAQ
===========

:Version: $Revision: 1.13 $

.. contents::


Installation
------------

Living without a mailserver
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Remove the nosy reactor, means delete the tracker file
``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.


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
-------------

I got an error and I cant reload it!
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you're using Netscape/Mozilla, try holding shift and pressing reload.
If you're using IE then install Mozilla and try again ;^)


I keep getting logged out
~~~~~~~~~~~~~~~~~~~~~~~~~

Make sure that the TRACKER_WEB setting in your tracker's config.py is set
to the URL of the tracker.


-----------------

Back to `Table of Contents`_

.. _`Table of Contents`: index.html
.. _`customisation`: customisation.html