Code

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