doc/FAQ.txt

   1 ===========
   2 Roundup FAQ
   3 ===========
   4
   5 :Version: $Revision: 1.16 $
   6
   7 .. contents::
   8
   9
  10 Installation
  11 ------------
  12
  13 Living without a mailserver
  14 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15
  16 Remove the nosy reactor, means delete the tracker file
  17 ``detectors/nosyreactor.py`` from your tracker home.
  18
  19
  20 The cgi-bin is very slow!
  21 ~~~~~~~~~~~~~~~~~~~~~~~~~
  22
  23 Yep, it sure is. It has to start up Python and load all of the support
  24 libraries for *every* request.
  25
  26 The solution is to use the built in server.
  27
  28 To make Roundup more seamless with your website, you may place the built
  29 in server behind apache and link it into your web tree
  30
  31
  32 How do I put Roundup behind Apache
  33 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  34
  35 We have a project (foo) running on ``foohost.com:8888``.
  36 We want ``http://foohost.com/FooIssues`` to use the roundup server, so we
  37 set that up on port 8888 on ``foohost.com`` with the ``config.py`` line::
  38
  39   TRACKER_WEB = 'http://foohost.com/FooIssues/'
  40
  41 We have a "foo_issues" tracker and we run the server with::
  42
  43   roundup-server -p 8888 foo_issues=/home/roundup/trackers/foo_issues
  44
  45 Then, on the Apache machine (eg. redhat 7.3 with apache 1.3), in
  46 ``/etc/httpd/conf/httpd.conf`` uncomment::
  47
  48   LoadModule proxy_module       modules/libproxy.so
  49
  50 and::
  51
  52   AddModule mod_proxy.c
  53
  54 Then add::
  55
  56   # roundup stuff (added manually)
  57   <IfModule mod_proxy.c>
  58
  59   RewriteEngine on
  60
  61   # General Roundup
  62   RewriteRule ^/Roundup$  Roundup/    [R]
  63   RewriteRule ^/Roundup/(.*)$ http://foohost.com:8888/$1   [P,L]
  64
  65   # Handle Foo Issues
  66   RewriteRule ^/FooIssues$  FooIssues/    [R]
  67   RewriteRule ^/FooIssues/(.*)$ http://foohost.com:8888/foo_issues/$1 [P,L]
  68
  69   </IfModule>
  70
  71 Then restart Apache. Now Apache will proxy the request on to the
  72 roundup-server.
  73
  74 You need to add the last 3 RewriteRule lines for each tracker that you have.
  75
  76 You can now firewall off port 8888 from the rest of the world.
  77
  78
  79 Roundup runs very slowly on my XP machine when accessed from the Internet
  80 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  81
  82 The issue is probably related to host name resolution for the client
  83 performing the request. You can turn off the resolution of the names
  84 when it's so slow like this. To do so, edit the module
  85 roundup/scripts/roundup_server.py around line 77 to add the following
  86 to the RoundupRequestHandler class:
  87
  88      def address_string(self):
  89          return self.client_address[0]
  90
  91
  92 Templates
  93 ---------
  94
  95 What is that stuff in the tracker html directory?
  96 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  97
  98 This is the template code that Roundup uses to display the various pages.
  99 This is based upon the template markup language in Zope called, oddly
 100 enough "Zope Page Templates". There's documentation in the Roundup
 101 customisation_ documentation. For more information have a look at:
 102
 103    http://www.zope.org/Documentation/Books/ZopeBook/current/contents
 104
 105 specifically chapter 5 "Using Zope Page Templates" and chapter 9 "Advanced
 106 Page Templates".
 107
 108
 109 But I just want a select/option list for ....
 110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 111
 112 Really easy... edit ``html/issue.item``. For 'nosy', change line 53 from::
 113
 114   <span tal:replace="structure context/nosy/field" />
 115
 116 to::
 117
 118   <span tal:replace="structure context/nosy/menu" />
 119
 120 For 'assigned to', change line 61 from::
 121
 122   <td tal:content="structure context/assignedto/field">assignedto menu</td>
 123
 124 to::
 125
 126   <td tal:content="structure context/assignedto/menu">assignedto menu</td>
 127
 128
 129
 130 Great! But now the select/option list is too big
 131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 132
 133 Thats a little harder (but only a little ;^)
 134
 135 Again, edit ``html/issue.item``. For nosy, change line 53 from:
 136
 137   <span tal:replace="structure context/nosy/field" />
 138
 139 to::
 140
 141   <span tal:replace="structure python:context.nosy.menu(height=3)" />
 142
 143 for more information, go and read about Zope Page Templates.
 144
 145
 146 Using Roundup
 147 -------------
 148
 149 I got an error and I cant reload it!
 150 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 151
 152 If you're using Netscape/Mozilla, try holding shift and pressing reload.
 153 If you're using IE then install Mozilla and try again ;^)
 154
 155
 156 I keep getting logged out
 157 ~~~~~~~~~~~~~~~~~~~~~~~~~
 158
 159 Make sure that the TRACKER_WEB setting in your tracker's config.py is set
 160 to the URL of the tracker.
 161
 162
 163 -----------------
 164
 165 Back to `Table of Contents`_
 166
 167 .. _`Table of Contents`: index.html
 168 .. _`customisation`: customizing.html
 169