initial version - extra platform independent code from BSE::Util::Tags
[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
b19047a6
TC
117=item randomdata
118
119Device to read random data from. This device should not block when it
120runs out of entropy.
121
122=back
123
124=head2 [mail]
125
126This section controls how BSE send email.
127
128=over
129
130=item smtp_server
131
132The host or IP address of your mail server. If this is not set
133C<sendmail> will be used instead. If this is set you must also set
134I<helo>.
135
136=item helo
137
138The name that BSE uses to identify itself when sending mail via SMTP.
139Required if I<smtp_server> is set.
140
141=item sendmail
142
143The path to the C<sendmail> binary. Default: /usr/lib/sendmail
144
145=item sendmail_opts
146
147The options supplied to sendmail. Default: -t -oi
148
149You may want to add the -odq option to this if you want mail queued
150rather than sent immediately.
151
61551101
TC
152=back
153
721cd24c
TC
154=head2 [children of id]
155
156Where I<id> is the identifier for an article.
157
158=over
159
160=item template
161
162the name of the default template for children of the given parent
163
164=item template_dirs
165
166a comma-separated list of extra directories under $TMPLDIR to search
167for templates that can be used for children of the given parent article.
168
169=back
170
61551101
TC
171=head2 [messages]
172
173This can be used to control translation of error messages. Each key
174has a prefix identifying the module that uses the error, followed by
175'/' followed by a specific identifier for the message.
176
177Message parameters, expressed as $I<digit>, are replaced with the
178parameters passed to the message. C<$$> is replaced with C<$>.
179
180Each message identifier below is documented with the id, when it
181occurs, the default message, and any parameters.
182
183=over
184
185=item user/needlogon
186
187the user attempted to logon without entering a logon name. Default:
188"Please enter a logon name". No parameters.
189
190=item user/needpass
191
192the user attempted to logon without entering a password. Default:
193"Please enter your password." No parameters.
194
195=item user/baduserpass
196
197the user's logon name or password was not found or did not match.
198Default: "Invalid user or password". No parameters.
199
200=item user/notloggedon
201
202the user attempted to logoff while not logged on. Default: "You
203aren't logged on". No parameters.
204
205=item user/optsoldpass
206
207the user entered a new password on the options page without entering
208their old password. Default: "You need to enter your old password to
209change your password". No parameters.
210
211=back
212
2404a911
TC
213=head2 [downloads]
214
215=over
216
217=item must_be_paid
218
219if non-zero, the order must be marked as paid for before the file can
220be downloaded.
221
222=item must_be_filled
223
224if non-zero the order must be marked as filled before the files can be
225downloaded.
226
227=back
228
b19047a6
TC
229=head2 [confirmations]
230
231Control over confirmation emails.
232
233=over
234
235=item subject
236
237The subject of email confirmation emails. Default: Subcription
238Confirmation.
239
240=item from
241
242The from field for the email. Default: $SHOP_FROM
243
244=back
245
531fb3bc
TC
246=head2 [subscriptions]
247
248Control over subscription messages.
249
250=over
251
252=item from
253
254The from field for the email. Default: $SHOP_FROM.
255
256=back
257
61551101
TC
258=head1 AUTHOR
259
260Tony Cook <tony@develop-help.com>
261
262=cut