Code

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