Code

More doc tweaks
[roundup.git] / doc / FAQ.txt
1 ===========
2 Roundup FAQ
3 ===========
5 :Version: $Revision: 1.9 $
7 NOTE: This is just a grabbag, most of this should go into documentation.
9 .. contents::
12 Changing HTML layout
13 --------------------
15 Note changes to the files in html take place immediatly without
16 restart, even when running roundup-server.
18 Displaying whole messages not only the summary
19 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21 Modify instance/html/msg.index change::
23    <td><display call="plain('summary')"></td>
25 to::
27    <td><pre><display call="plain('content')"></pre></td>
29 displays the whole message not only the first line and 'pre'
30 prevents the browser from reformatting. 
32 Getting the nosy list picker instead of textfield
33 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35 In classic template there is plenty of space below the text field.
36 So one could modify instance/html/issue.item to use it.
38 At the file top set 'border=1' to see cell boundaries, then
39 replace::
41   <td class="form-text"><display call="field('nosy',size=20)"></td>
42   
43 by::
45   <td rowspan=5 class="form-text"><display call="menu('nosy',height=10)"></td>
47 and remove the last cell in the next four rows, either by deleting a cell
48 or by reducing colspan.
50 Want to see the issue id (the number) on the issue item display
51 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53 The number is really a central information and not an internal one.
55 In file INSTANCE/html/issue.item displays the creator, so one could add
56 the number to it.::
58   <td class="form-text"><display call="reldate('creation', pretty=1)">
59       (<display call="plain('creator')">)</td>
61 to see::
63   <td class="form-text"><display call="reldate('creation', pretty=1)">
64       (issue<display call="plain('id')"> by <display call="plain('creator')">)</td>
66 Installation
67 ------------
69 Living without a mailserver.
70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72 Remove the nosy reactor, means delete the file
73 'INSTANCE/detectors/nosyreactor.py'.
76 Rights issues (MISSING)
77 ~~~~~~~~~~~~~~~~~~~~~~~
79 Different jobs run under different users.
81 * Standalone roundup-server is started by whome ?
83 * Running cgi under apache.
85 * roundup-mailgw called via .forward from MTA, or running a cron job
86   fetching via pop.
88 see Troubleshooting_.
91 Troubleshooting
92 ---------------
94 AttributeError: '_roundup_instance_1' module has no attribute 'open'
95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
97 For example submitting issues via roundup-mailgw breaks similar to this::
99   Command died with status 1:
100   "/usr/local/bin/python /usr/local/bin/roundup-mailgw /home/roundup".
101   Command output: Traceback (most recent call last):  
102     File "/usr/local/bin/roundup-mailgw", line 178, in ? 
103        sys.exit(main(sys.argv))
104     File "/usr/local/bin/roundup-mailgw", line 153, in main 
105       db = instance.open('admin')
106        AttributeError: '_roundup_instance_1' module has no attribute 'open'
108 Happens if the user which accesses the instance has no read right
109 on 'INSTANCE/dbinit.py' or 'pyc'. 
111 If the user has no rights on the 'INSTANCE/db' the mailgw finishes,
112 but is, of course, unable to add the message. A notification to
113 the roundup-admin is sent, with a longer trace ending in::
115   File "/opt/python/lib/python2.2/dbhash.py", line 16, in open
116     return bsddb.hashopen(file, flag, mode)
117   error: (13, 'Keine Berechtigung')
119 Replace 'Keine Berechtigung' by 'Not permitted' or ...
121 An easy way to test whether it's a permissions problem, or some other mail
122 server configuration problem is to cat an email-formatted text file
123 directly to the roundup-mailgw script as the roundup user.::
125   cat issue.txt | /usr/local/bin/roundup-mailgw /home/roundup
127 If that doesn't raise any errors, the problem is the permissions of the
128 MTA. 
130 -----------------
132 Back to `Table of Contents`_
134 .. _`Table of Contents`: index.html