Mercurial > p > roundup > code

annotate doc/FAQ.txt @ 659:e429649ed124

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