Mercurial > p > roundup > code

annotate doc/FAQ.stx @ 633:7875cd9af1cb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documentation in structured text source form
author Richard Jones <richard@users.sourceforge.net>
date Thu, 21 Feb 2002 06:22:00 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 Roundup FAQ
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 ===========
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 '$Date: 2002-02-21 06:22:00 $'
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 NOTE: This is just a grabbag, most of this should go into documentation.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 Changing HTML layout
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9 --------------------
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 Note changes to the files in html take place immediatly without
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 restart, even when running roundup-server.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 Displaying whole messages not only the summary
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 Modify instance/html/msg.index change::
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 <td><display call="plain('summary')"></td>
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 to::
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 <td><pre><display call="plain('content')"></pre></td>
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 displays the whole message not only the first line and 'pre'
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 prevents the browser from reformatting.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28 Getting the nosy list picker instead of textfield
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 In classic template there is plenty of space below the text field.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32 So one could modify instance/html/issue.item to use it.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 At the file top set 'border=1' to see cell boundaries, then
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 replace::
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 <td class="form-text"><display call="field('nosy',size=20)"></td>
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39 by::
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 <td rowspan=5 class="form-text"><display call="menu('nosy',height=10)"></td>
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 and remove the last cell in the next four rows, either by deleting a cell
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 or by reducing colspan.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 Want to see the issue id (the number) on the issue item display
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 The number is really a central information and not an internal one.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 In file INSTANCE/html/issue.item displays the creator, so one could add
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 the number to it.::
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54 <td class="form-text"><display call="reldate('creation', pretty=1)">
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55 (<display call="plain('creator')">)</td>
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 to see::
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59 <td class="form-text"><display call="reldate('creation', pretty=1)">
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60 (issue<display call="plain('id')"> by <display call="plain('creator')">)</td>
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62 Installation
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63 ------------
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65 Living without a mailserver.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
66 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
67
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
68 Remove the nosy reactor, means delete the file 'INSTANCE/detectors/nosyreactor.py'.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
70 Rights issues (MISSING)
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71 ~~~~~~~~~~~~~~~~~~~~~~~
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
72
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73 Different jobs run under different users.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75 * Standalone roundup-server is started by whome ?
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
76
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77 * Running cgi under apache.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
78
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
79 * roundup-mailgw called via .forward from MTA, or running a cron job
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
80 fetching via pop.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
82 see Troubleshooting.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
83
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
84 Troubleshooting
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
85 ---------------
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
86
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
87
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88 AttributeError: ''_roundup_instance_1'' module has no attribute 'open'
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91 Sorry: in html it is not formatted correct.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
93 For example submitting issues via roundup-mailgw breaks similar to this.::
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
94
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
95 Command died with status 1:
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
96 "/usr/local/bin/python /usr/local/bin/roundup-mailgw /home/roundup".
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97 Command output: Traceback (most recent call last):
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
98 File "/usr/local/bin/roundup-mailgw", line 178, in ?
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
99 sys.exit(main(sys.argv))
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
100 File "/usr/local/bin/roundup-mailgw", line 153, in main
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
101 db = instance.open('admin')
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
102 AttributeError: '_roundup_instance_1' module has no attribute 'open'
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
103
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
104 Happens if the user which accesses the instance has no read right
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
105 on 'INSTANCE/dbinit.py' or 'pyc'.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
106
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
107 If the user has no rights on the 'INSTANCE/db' the mailgw finishes,
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
108 but is, of course, unable to add the message. A notification to
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
109 the roundup-admin is sent, with a longer trace ending in::
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
110
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
111 File "/opt/python/lib/python2.2/dbhash.py", line 16, in open
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
112 return bsddb.hashopen(file, flag, mode)
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
113 error: (13, 'Keine Berechtigung')
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
115 Replace 'Keine Berechtigung' by 'Not permitted' or ...
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
116
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
117 An easy way to test whether it's a permissions problem, or some other mail
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
118 server configuration problem is to cat an email-formatted text file
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
119 directly to the roundup-mailgw script as the roundup user.::
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
120
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
121 cat issue.txt | /usr/local/bin/roundup-mailgw /home/roundup
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
122
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
123 If that doesn't raise any errors, the problem is the permissions of the
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
124 MTA.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
125
Roundup Issue Tracker: http://roundup-tracker.org/