not quite the initial release - it wasn't saving the index name
[bse.git] / site / docs / config.pod
CommitLineData
61551101
TC
1=head1 NAME
2
3config.pod - documents BSE configuration file options
4
5=head1 DESCRIPTION
6
7BSE historically used Constants.pm to keep most configuration
8information. The plan is to make sure any new configuration is kept
9in bse.cfg, and to slowly move most configuration information into
10bse.cfg.
11
12Keeping configuration information in Constants.pm makes it difficult
13to perform upgrades and makes it impossible to use tools such as
14mod_perl, at least if you want more than one site on the machine.
15
16=head1 CONFIGURATION ENTRIES
17
18=head2 [paths]
19
20Contains various file system paths.
21
22=over
23
24=item downloads
25
26This is where the files uploads with the file wizard are stored. It
27must be writable by the web server user.
28
29=item admin_templates
30
31Directory containing administrative templates. Note: this is not
32completely implemented for now, so assume the default. Default: admin
33directory under $TMPLDIR.
34
35=item templates
36
37Directory base for most templates. Note: this is not completely
38implemented for now, so assume the default. Default: $TMPLDIR.
39
40=back
41
42=head2 [extensions]
43
44This section is used by the file wizard to map uploaded file
45extensions to MIME content types. This can be used to extend
46BSE::FileEditor's internal extension map. It cannot override that
47map.
48
49The key for each entry is the extension, without the leading '.'.
50
51eg.
52
53 xls = application/msexcel
54
55=head2 [templates]
56
57Used for translating symbolic template names into full names under the
58template directory.
59
60In each case the default is the name with a C<.tmpl> extension.
61
62=over
63
64=item user/logon
65
66user logon page
67
68=item user/register
69
70user registration page
71
72=back
73
74=head2 [admin templates]
75
76Used for translating the names of administration templates into filenames.
77
78In each case the default is the name with a C<.tmpl> extension.
79
80=over
81
82=item filelist
83
84article file wizard
85
86=back
87
88=head2 [html]
89
90Minor html items.
91
92=over
93
94=item charset
95
96The value of the charset keyword when outputting HTML from a script.
97Set to the empty string to suppress the charset keyword. Default:
98iso-8859-1.
99
100=back
101
102=head2 [basic]
103
104=over
105
106=item cookie_lifetime
107
108The expiry time for cookies. This should be in the form supported by
109CGI.pm for the -expires parameter. Typically you want a plus ('+'), a
110number, and a time character (s - seconds, m - minutes, h - hours, d -
111days, M - months). Default: +3h
112
113=item minpassword
114
115Minimum password length in characters. Default: 4.
116
117=back
118
721cd24c
TC
119=head2 [children of id]
120
121Where I<id> is the identifier for an article.
122
123=over
124
125=item template
126
127the name of the default template for children of the given parent
128
129=item template_dirs
130
131a comma-separated list of extra directories under $TMPLDIR to search
132for templates that can be used for children of the given parent article.
133
134=back
135
61551101
TC
136=head2 [messages]
137
138This can be used to control translation of error messages. Each key
139has a prefix identifying the module that uses the error, followed by
140'/' followed by a specific identifier for the message.
141
142Message parameters, expressed as $I<digit>, are replaced with the
143parameters passed to the message. C<$$> is replaced with C<$>.
144
145Each message identifier below is documented with the id, when it
146occurs, the default message, and any parameters.
147
148=over
149
150=item user/needlogon
151
152the user attempted to logon without entering a logon name. Default:
153"Please enter a logon name". No parameters.
154
155=item user/needpass
156
157the user attempted to logon without entering a password. Default:
158"Please enter your password." No parameters.
159
160=item user/baduserpass
161
162the user's logon name or password was not found or did not match.
163Default: "Invalid user or password". No parameters.
164
165=item user/notloggedon
166
167the user attempted to logoff while not logged on. Default: "You
168aren't logged on". No parameters.
169
170=item user/optsoldpass
171
172the user entered a new password on the options page without entering
173their old password. Default: "You need to enter your old password to
174change your password". No parameters.
175
176=back
177
2404a911
TC
178=head2 [downloads]
179
180=over
181
182=item must_be_paid
183
184if non-zero, the order must be marked as paid for before the file can
185be downloaded.
186
187=item must_be_filled
188
189if non-zero the order must be marked as filled before the files can be
190downloaded.
191
192=back
193
61551101
TC
194=head1 AUTHOR
195
196Tony Cook <tony@develop-help.com>
197
198=cut