add a host config parameter for S3 storages
[bse.git] / site / docs / config.pod
1 =head1 NAME
2
3 config.pod - documents BSE configuration file options
4
5 =head1 DESCRIPTION
6
7 BSE historically used Constants.pm to keep most configuration
8 information.  The plan is to make sure any new configuration is kept
9 in bse.cfg, and to slowly move most configuration information into
10 bse.cfg.
11
12 Keeping configuration information in Constants.pm makes it difficult
13 to perform upgrades and makes it impossible to use tools such as
14 mod_perl, at least if you want more than one site on the machine.
15
16 F<bse.cfg> is read as a utf-8 encoded file.
17
18 =head1 CONFIGURATION ENTRIES
19
20 =head2 [site]
21
22 Contains URL configuration for the site.
23
24 =over
25
26 =item url
27
28 The normal URL for the non-secure parts of the site.
29
30 =item secureurl
31
32 The secure URL for the shop, products and other portions of the site
33 that should use SSL.  This isn't checked to make sure it is https.
34
35 =item name
36
37 Used as the site "name" in a few places.
38
39 =item adminurl
40
41 If set, this is used as the base URL for accessing the administrative
42 functions of your site.
43
44 =item secureadmin
45
46 Ignored if C<adminurl> is set.
47
48 If this is true then C<secureurl> is used as the base URL for
49 accessing the administrative functions of your site, otherwise C<url>
50 is used as the base URL.  Default: false (C<url>'s value is used)
51
52 =item forward_from
53
54 Configure the IP address of one or more front-end proxies.  This can
55 be a regular expression except that C<.> is translated to C<\.> and
56 C<*> is tranlated to C<.*> to give more glob() like matching.
57
58 If the reqesting host matches then admin site URL matching is done
59 against HTTP_X_FORWARDED_SERVER instead of SERVER_NAME.
60
61 Default: no front-end server configured.
62
63 =item secret
64
65 A secret used (currently) for hashing cookie values passed between the
66 secure and non-secure parts of the site.  This must be set.  A
67 suitable value can be created with:
68
69   openssl rand -base64 32
70
71 =back
72
73 =head2 [paths]
74
75 Contains various file system paths.
76
77 =over
78
79 =item downloads
80
81 This is where the files uploads with the file wizard are stored.  It
82 must be writable by the web server user.
83
84 =item admin_templates
85
86 Directory containing administrative templates.  Note: this is not
87 completely implemented for now, so assume the default.  Default: admin
88 directory under $TMPLDIR.
89
90 =item templates
91
92 Directory base for most templates.  This can contain references like
93 $(section/key) to other configuration entries.  Split on the systems
94 PATH separators (run: perl -V:path_sep)
95
96 =item local_templates
97
98 Local Directory base for templates.  This is searched before the
99 templates directory.  This can contain references like $(section/key)
100 to other configuration entries.  Split on the system's PATH separator.
101
102 =item public_html
103
104 Web server document root.  Static pages are generated under this
105 directory.  Default: $CONTENTBASE.
106
107 =item images
108
109 Where uploaded images are stored.  This is not yet completely
110 implemented.  Default: $IMAGEDIR.
111
112 =item libraries
113
114 Local search path for BSE::Custom, or the class configured by
115 C<custom_class> in [basic].
116
117 =item scalecache
118
119 The directory where cached versions of scaled thumbnails are stored.
120 Defaults to I<[paths].images>F</scaled>.  This must be in the document tree.  If
121 you set this you should also set I<[uri].scalecache>.
122
123 =item siteuser_images
124
125 Where uploaded siteuser images are stored.  This must be set in the
126 config file.  The default bse.cfg include an entry to use the current
127 values of [paths].downloads
128
129 =item dynamic_cache
130
131 Pregenerated dynamic article pages are stored here.  This must be
132 defined if you site contains any dynamicly generated pages.
133
134 =item public_files
135
136 The directory to store public BSE::TB::File content in (currently used
137 for application specific files.)
138
139 =back
140
141 =head2 [extensions]
142
143 This section is used by the file wizard to map uploaded file
144 extensions to MIME content types.  This can be used to extend
145 BSE::FileEditor's internal extension map.  It cannot override that
146 map.
147
148 The key for each entry is the extension, without the leading '.'.
149
150 eg.
151
152   xls = application/msexcel
153
154 =head2 [templates]
155
156 Used for translating symbolic template names into full names under the
157 template directory.
158
159 In each case the default is the name with a C<.tmpl> extension.
160
161 =over
162
163 =item user/logon
164
165 user logon page
166
167 =item user/register
168
169 user registration page
170
171 =back
172
173 =head2 [admin templates]
174
175 Used for translating the names of administration templates into filenames.
176
177 In each case the default is the name with a C<.tmpl> extension.
178
179 =over
180
181 =item filelist
182
183 article file wizard
184
185 =item catalog
186
187 Catalog editor page.  Default admin/edit_catalog.tmpl
188
189 =item Z<>1
190
191 =item Z<>2
192
193 =item Z<>3
194
195 =item Z<>4
196
197 =item Z<>5
198
199 Article edit pages.  Default admin/edit_<number>.tmpl
200
201 =item steps
202
203 Step child/parent management page.  Default admin/edit_steps.tmpl
204
205 =back
206
207 =head2 [html]
208
209 Minor html items.
210
211 =over
212
213 =item charset
214
215 The value of the charset keyword when outputting HTML from a script.
216 Set to the empty string to suppress the charset keyword.  Default:
217 iso-8859-1.
218
219 =item redirect_links
220
221 If this is a non-zero number, then all but mailto links are redirected
222 to C<nuser.pl/redirect> so you can display a diclaimer.  If this
223 contained alphabetics it's treated as a comma separated list of url
224 schemes that should be handled via C<nuser.pl/redirect>.  If 0 or not
225 present, no redirection is done.
226
227 The redirect URL includes a hash of the url, title and the redirect
228 salt to prevent using this mechanism by external sites for cookie
229 stealing attacks.
230
231 =item redirect_salt
232
233 The salt used in generating the has for redirect_links.  Default: an
234 empty string.
235
236 =item validate
237
238 If non-zero then any HTML output is validated with HTML::Tidy.
239 Validation errors and warnings are sent to the audit log.  See [html
240 tidy].
241
242 =item tagformat
243
244 The default tag formatting to use for C<< <:= ... :> >> tags.
245 Default: C<html>.
246
247 =item formatter_image_class
248
249 The default class to use for image[...]  tags in body text.  Default:
250 C<bse_image_inline>.
251
252 =back
253
254 =head2 [basic]
255
256 =over
257
258 =item access_control
259
260 If this is true then the user/group/permissions database is used to
261 control access to the system.  Default: False.
262
263 =item access_filter_parents
264
265 If this is true, then the drop-down lists of possible parents on the
266 newsletter edit pages are filtered for access control.
267 Default: False.
268
269 =item access_filter_steps
270
271 If this is true, then the drop-down lists of possible stepparents and
272 stepchildren on the article edit pages are filtered for access control.
273 Default: False.
274
275 =item alias_prefix
276
277 The prefix applied to articles that use a linkAlias url.  This should
278 start with a /.
279
280 =item alias_recursive
281
282 If this is non-zero then the link is formed by the C<alias_prefix>,
283 followed by slash (C</>) separated aliases from the ancestors starting
284 from the section, followed by the C<alias_suffix>.  You may need to
285 change your redirect handling if you enable this.  Default: Off.
286
287 =item alias_suffix
288
289 If this is non-zero then the title is cleaned up (all but
290 alphanumerics removed) and appended to the alias URL generated.
291
292 =item all_dynamic
293
294 If true then all articles are treated as dynamic.  Default: false.
295
296 =item auto_images
297
298 By default, if the author doesn't use any image tags, BSE will insert
299 any unnamed article images into the body text of an article.  You can
300 disable this on a per-article basis in the image tool, or disable it
301 globally by setting C<auto_images> to 0.
302
303 An alternative is to set C<imagePos> in C<[article defaults]> to
304 C<xx> which will default articles to not auto-inserting images.
305
306 =item cache_templates
307
308 If true, BSE will cache compiled templates using the configured BSE
309 cache, if any.  Depending on the configured cache this may slow things
310 down.  Default: disabled.
311
312 =item cache_templates_locally
313
314 If true, BSE will cache compiled templates in memory.  This may
315 significantly improve performance but may increase memory use.
316 Default: disabled.
317
318 =item cache_thumbnails
319
320 If set to zero the results of the thumbimage/gthumbimage body/template
321 tags will not be cached.  Default: 1 (caching is enabled).
322
323 =item cookie_domain
324
325 This overrides the domain value set for cookies.  This is useful if
326 you allow the site to run under both example.com and www.example.com,
327 if you set cookie_domain to example.com then a user visiting
328 www.example.com will still have their cookies when they visit
329 example.com.
330
331 =item cookie_lifetime
332
333 The expiry time for cookies.  This should be in the form supported by
334 CGI.pm for the -expires parameter.  Typically you want a plus ('+'), a
335 number, and a time character (s - seconds, m - minutes, h - hours, d -
336 days, M - months).  Set to an empty string for session cookies.
337 Default: +3h
338
339 =item cookie_name
340
341 This overrides the cookie name used to store the session id.  Default:
342 sessionid.  This is useful when you have 2 sites under the same
343 top-level domain, and helps disambiguate the cookie returned by the
344 browser.
345
346 =item custom_class
347
348 The name of the custom class for your site.  This is currently only
349 used for article editing customizations.  This class should derive
350 from BSE::CustomBase.  Default: BSE::Custom.
351
352 =item default_popupimage
353
354 This is the default popup image class for the popimage[] and
355 gpopimage[] tags.  Default: popup.
356
357 =item dynamic_access_filter
358
359 If set to 0, dynamic article iterators will no access control filter
360 their results.  Default: 1.
361
362 =item error_not_defined
363
364 If non-zero, during dynamic page generation, inserts a message
365 explaining which variable is not set, instead of just leaving the tag
366 unreplaced.  Default: 1.
367
368 =item http_only_session
369
370 If this is non-zero, the default, the session cookie sent to the
371 browser has the C<HttpOnly> attribute set.  This can prevent session
372 cookie hijacking.  Default: 1.
373
374 =item htusers
375
376 This should be the path to a file to be updated with the list of users
377 and crypt() versions of their passwords.  If this is set then the
378 security system will check for a user set by the browser before
379 attempting a form based logon.  Default: None.
380
381 =item index_file
382
383 The name of the file to generate for static articles when the link is
384 terminated by "/".  Default: C<index.html>.
385
386 =item jit_dynamic_pregen
387
388 If this is true, then pre-generation for dynamic pages will be delayed
389 until the page is displayed to a user.  Default: off.
390
391 =item link_titles
392
393 If this is true then the links to your articles within BSE will be
394 followed by a / and then by a simplified version of the article title.
395 The aim is to include at least some title information in the URL
396 without modifying the name of the HTML file.  Default: False.
397
398 =item make_userid_cookie
399
400 If this is non-zero, the default, then when the site member logs in, a
401 javascript visible cookie, C<userid> will be set that contains the
402 login name of the user.  BSE's back-end doesn't use this cookie, its
403 only use is for Javascript to enable/disable user interface elements.
404 Default: 1.
405
406 =item minpassword
407
408 Previously the minimum length of site user passwords in characters.
409 You must now set C<length> in C<[siteuser passwords]>.
410
411 =item no_cache_dynamic
412
413 If non-zero, the default, dynamic responses will include a
414 C<Cache-Control: no-cache> header.  This can be overridden for
415 articles via , article flags, C<[template >
416 I<templatename>C<].no_cache_dynamic> and [article].no_cache_dynamic.
417 Default: 1.
418
419 =item preload_template
420
421 Preload the named template, searching the template search part.  Any
422 text that would normally be produced by the preloaded template is
423 ignored.  This can be useful for common definitions and variables for
424 use in many templates.  Default: none.
425
426 =item randomdata
427
428 Device to read random data from.  This device should not block when it
429 runs out of entropy.
430
431 =item redir_to_alias
432
433 If true then page.pl will 301 redirect (Moved Permanently) requests
434 for an article by its id to the generated link if the article has a
435 link alias.  Default: false.  Must only be used with use_alias true.
436
437 =item secure_session
438
439 If this is non-zero then the session cookie sent to the browser has
440 the C<Secure> attribute set.  This means that the cookie will only be
441 visible over https.  This is only useful when the only URL the site is
442 visited over is a https URL.  Default: 0.
443
444 =item server_auth
445
446 Set this to non-zero to enable authentication via server
447 authentication (usually Basic Authentication.)  You should normally
448 set this if you set htusers below.  Default: 0 (disabled)
449
450 =item sign
451
452 If this is true then the encrypted messages containing the customer's
453 credit card number are sent to the shop owner signed.  To avoid
454 keeping a passphrase and signing key on the server you can set this to
455 false (0).  This has the effect that anyone could send you an unsigned
456 message encrypted with your public key, though this may not be a
457 security threat.  Default: True.
458
459 =item staticajax
460
461 If true, the ifAjax and ajax tags will be active for static pages.
462
463 =item static_thumbnails
464
465 If true and cache_thumbnails is true then thumbnails for the thumbnail
466 cache will be generated when a static page is regenerated, and the
467 link from the page will link to the image in the cache rather than to
468 C<thumb.pl>.  Default: 1 (static thumbnails enabled).
469
470 =item track_uploads
471
472 If this is non-zero, and a cache is configured (see [cache]), file
473 uploads are tracked in entries in the cache.
474
475 The fileprogress.pl script can be called by Ajax to display file
476 upload progress information to the user.  The upload state is updated
477 a maximum of once a second.
478
479 =item use_alias
480
481 If this is non-zero then an article with linkAlias set will use an
482 alias url instead of the "real" url.  You will need to configure a
483 RewriteRule or ErrorDocument to page.pl to direct the user to the
484 correct URL.  Default: 1.
485
486 =item warn_obsolete
487
488 Some obsolete tags will warn to stderr if this is non-zero.  Default:
489 don't warn.
490
491 =back
492
493 =head2 [mail]
494
495 This section controls how BSE sends email.
496
497 =over
498
499 =item smtp_server
500
501 The host or IP address of your mail server.  If this is not set
502 C<sendmail> will be used instead.  If this is set you must also set
503 I<helo>.
504
505 =item helo
506
507 The name that BSE uses to identify itself when sending mail via SMTP.
508 Required if I<smtp_server> is set.
509
510 =item sendmail
511
512 The path to the C<sendmail> binary.  Default: /usr/lib/sendmail
513
514 =item sendmail_opts
515
516 The options supplied to sendmail.  Default: -t -oi
517
518 You may want to add the -odq option to this if you want mail queued
519 rather than sent immediately.
520
521 =item set_errors_to_from
522
523 If true, we add an Errors-To header set to the same as the From
524 header.  Default: true.
525
526 =item html_system_email
527
528 If non-zero then emails sent via the compose mail system that aren't
529 being sent to a member record, will be sent as HTML, if the HTML
530 template is available.
531
532 =item inline_css
533
534 If this is C<style> (the default) then use CSS::Inliner to attempt to
535 inline CSS in mail if the text "<style" is found in the generated
536 HTML.
537
538 If this is C<force> then we always attempt to inline CSS.
539
540 If this is any other value then don't inline CSS.
541
542 =item inline_css_flags
543
544 A comma separated list of flags to supply to CSS::Inliner->new().
545 Reasonable flags are C<strip_attrs> to strip C<id> and C<class>
546 attributes, and C<leave_style> to leave the HTML style block in place.
547
548 Default: no flags.
549
550 =item inline_css_report
551
552 If this is true and CSS inlining fails, log an error to the audit
553 log. This is intended for use in debugging and should be disabled in
554 production.  Default: false (disabled)
555
556 =back
557
558 =head2 [children of I<id>]
559
560 Where I<id> is the identifier for an article.
561
562 =over
563
564 =item template
565
566 the name of the default template for children of the given parent
567
568 =item template_dirs
569
570 a comma-separated list of extra directories under $TMPLDIR to search
571 for templates that can be used for children of the given parent article.
572
573 =back
574
575 =head2 [article I<id>]
576
577 Where I<id> is the identifier of an article.
578
579 =over
580
581 =item template_dirs
582
583 A comma-separated list of extra directories under $TMPLDIR to search
584 for templates that can be used for children of the given parent
585 article.
586
587 =item extra_templates
588
589 A comma-separated list of extra templates under $TMPLDIR that can be
590 used for the given article.
591
592 =back
593
594 =head2 [level I<level>]
595
596 =over
597
598 =item template
599
600 The default template for this level of article, assuming it hasn't
601 been set in the [children of I<article id>] section.
602
603 =item template_dirs
604
605 A comma-separated list of extra directories under $TMPLDIR to search
606 for templates that can be used for articles at the given I<level>.
607
608 =back
609
610 =head2 [catalogs]
611
612 =over
613
614 =item template
615
616 The default template for catalogs.
617
618 =back
619
620 =head2 [products]
621
622 =over
623
624 =item template
625
626 The default template for products.
627
628 =item extra_templates
629
630 A comma separated list of extra templates that can be used for
631 products.
632
633 =back
634
635 =head2 [messages]
636
637 This can be used to control translation of error messages.  Each key
638 has a prefix identifying the module that uses the error, followed by
639 '/' followed by a specific identifier for the message.
640
641 Message parameters, expressed as $I<digit>, are replaced with the
642 parameters passed to the message.  C<$$> is replaced with C<$>.
643
644 Each message identifier below is documented with the id, when it
645 occurs, the default message, and any parameters.
646
647 =over
648
649 =item user/needlogon
650
651 the user attempted to logon without entering a logon name.  Default:
652 "Please enter a logon name".  No parameters.
653
654 =item user/needpass
655
656 the user attempted to logon without entering a password.  Default:
657 "Please enter your password."  No parameters.
658
659 =item user/baduserpass
660
661 the user's logon name or password was not found or did not match.
662 Default: "Invalid user or password".  No parameters.
663
664 =item user/notloggedon
665
666 the user attempted to logoff while not logged on.  Default: "You
667 aren't logged on".  No parameters.
668
669 =item user/optsoldpass
670
671 the user entered a new password on the options page without entering
672 their old password.  Default: "You need to enter your old password to
673 change your password".  No parameters.
674
675 =item shop/logonrequired
676
677 Displayed if the user attempts to checkout when [shop].require_logon
678 is true.
679
680 =back
681
682 =head2 [downloads]
683
684 =over
685
686 =item must_be_paid
687
688 if non-zero, the order must be marked as paid for before the file can
689 be downloaded.
690
691 =item must_be_filled
692
693 if non-zero the order must be marked as filled before the files can be
694 downloaded.
695
696 =item require_logon
697
698 if non-zero the user must be registered/logged on to download I<any>
699 file.
700
701 =item log_downufile
702
703 if non-zero, downloads of userfiles will be logged.  Default: 0
704
705 =item log_downufile_maxage
706
707 the maximum age of entries in the user file download log, in days.
708 Default: 30.
709
710 =back
711
712 =head2 [confirmations]
713
714 Control over confirmation emails.
715
716 =over
717
718 =item subject
719
720 The subject of email confirmation emails.  Default: Subcription
721 Confirmation.
722
723 =item from
724
725 The from field for the email.  Default: $SHOP_FROM
726
727 =back
728
729 =head2 [subscriptions]
730
731 Control over subscription messages.
732
733 =over
734
735 =item from
736
737 The from field for the email.  Default: $SHOP_FROM.
738
739 =item testname
740
741 Default for the "Test Name" field for sending test subscription
742 messages.
743
744 =item testemail
745
746 Default for the "Test Email" field for sending test subscription
747 messages.
748
749 =item testtextonly
750
751 Set to 1 if you want the "Test Text Only" box checked by default for
752 sending test subscription messages.
753
754 =item testing
755
756 Set to 0 to disable display of the test subscription messages portions
757 of the subscriptions send form.
758
759 =item text_link_inline
760
761 Set to format links as they appear in the text version of emails.
762 C<$1> is replaced with the title, C<$2> with the URL and C<$3> with
763 the index. C<$$> is replaced with '$'. Default: C<$1 [$3]>
764
765 =item text_link_list
766
767 Set to format links as they appear at the footer of the body text.  If
768 this is set to the empty string then no list appears. C<$1>, C<$2>,
769 C<$3>, C<$$> are replaced as for I<text_link_inline> and $n is
770 replaced with newline.  Default: C<[$3] $2>
771
772 =item text_link_list_prefix
773
774 A line of text produced above the list of URLs if there is one.
775 Default: C<----->. $n in this is replaced with newlines.
776
777 =back
778
779 For example, if the configuration is:
780
781   text_link_inline="$1" ($3)
782   text_link_list_prefix=$n$n-------
783   text_link_list=($3) "$1"$n  => $2
784
785 and the body text is:
786
787   doclink[3]
788   link[http://www.example.com/|Example]
789
790 the result will be:
791
792   "The Shop" (1)
793   "Example" (2)
794   
795   
796   -------
797   (1) "The Shop"
798     => http://www.yoursite.com/shop/index.html
799   (2) "Example"
800     => http://www.example.com/
801
802 =head2 [search]
803
804 =over
805
806 =item highlight_partial
807
808 If this is true then partial matches will be highlight in search
809 result excerpts.  Default: True
810
811 =item keep_inaccessible
812
813 If this is true then resulting articles that can't be accessed by the
814 user are listed in the search results.  Default: false.
815
816 =item wordre
817
818 The default regular expression used to match words in text during
819 indexing.  Default: \w+
820
821 =item wordre_I<fieldname>
822
823 The field specific word match regular expression for the built-in
824 search indexer.  Default: the value of C<wordre>.
825
826 =item indexer
827
828 Module used to build the search index.  Default: BSE::Index::BSE.
829
830 =item index_priority
831
832 For C<BSE::Index::BSE>, the optimization priority.  The default of
833 C<speed> builds the index in memory and is very fast, but can consume
834 a lot of memory.  Otherwise, set this to C<memory> to reduce memory
835 usage.
836
837 C<memory> priority index building requires that the C<DBM::Deep>
838 module be installed.
839
840 =item level
841
842 Articles with a higher level than this are indexed as their ancestor.
843 Default: C<$SEARCH_LEVEL> which defaults to 5.
844
845 =back
846
847 =head2 [search highlight]
848
849 Sets the prefix and suffix used for highlighting matches for different
850 fields.
851
852 These are used by the highlight_result, excerpt, pageTitle, author,
853 keywords and matchFile tags.
854
855 Each field has a prefix and suffix entry.  The key is
856 I<fieldname>_prefix or I<fieldname>_suffix.  For file fields this is
857 file_I<fieldname>_prefix and file_I<fieldname>_suffix.
858
859 The default prefix is <b>.  The default suffix is </b>.
860
861 For example you can do:
862
863   [search highlight]
864   body_prefix=<span class="searchfound">
865   body_suffix=</span>
866   
867 The default prefix and suffix can also be redefined:
868
869   [search highlight]
870   prefix=<mark>
871   suffix=</mark>
872
873 =head2 [shop]
874
875 =over
876
877 =item enabled
878
879 Used by some templates to check if the shop is enabled.  Set this to 1
880 to enable the shop, or 0 to disable it.
881
882 =item secureurl_articles
883
884 If this is false then shop articles will not use the secureurl as their 
885 baseurl.  Default: True
886
887 =item register_if_files
888
889 If true the customer is required to register before checkout if there
890 are any for sale files attached to products in the cart.  Default: True
891
892 =item require_logon
893
894 If true the customer is required to be logged on before checkout,
895 whether or not for sale files are attached to products in the cart.
896 Default: False.
897
898 =item payment_types
899
900 A comma-separated list of acceptable payment types.  Default: 0
901
902 The possible payment types are:
903
904 =over
905
906 =item *
907
908 0 - the user enters a credit card number, name and expiry date
909
910 =item *
911
912 1 - the customer will send a cheque
913
914 =item *
915
916 2 - contact customer for details
917
918 =item *
919
920 4 - paypal - see L<paypal.pod>
921
922 =back
923
924 Other types can be added by adding entries to the [payment type names]
925 and [payment type descs] sections.
926
927 =item address1
928
929 =item address2
930
931 =item address3
932
933 These are used by various shop templates to present an address that a
934 cheque payment should be sent to.
935
936 =item from
937
938 From email address for emails sent by the shop.  Overides $SHOP_FROM
939 in Constants.pm
940
941 =item to_name
942
943 To name for emailed orders sent by the shop.  Overrides $SHOP_TO_NAME
944 in Constants.pm
945
946 =item to_email
947
948 To email for emailed orders sent by the shop.  Overrides $SHOP_TO_EMAIL
949 in Constants.pm
950
951 =item bcc_email
952
953 BCC email address for order confirmation emails sent to the customer.
954 Default: No bcc.
955
956 =item noencrypt
957
958 If this is true then orders sent to you by the shop will not be
959 encrypted.  Enabling this disabled acceptance of credit card orders,
960 and the default for C<payment_types> will become C<1> instead or C<0>.
961
962 Please realize that other potentially commercially sensitive
963 information is being sent in the clear to a central location,
964 unencrypted.
965
966 =item email_order
967
968 If true, then the order is email to to_email, possibly with credit
969 card information included.  Default: $SHOP_EMAIL_ORDER.
970
971 =item display_I<field>
972
973 Used to translate the stored order field name into a presentation name
974 suitable for error messages.
975
976 =item cardprocessor
977
978 The name of a class to load to process credit card transactions online.
979
980 Currently this can be either DevHelp::Payments::Test or
981 DevHelp::Payments::Inpho.
982
983 =item crypt_module
984
985 Name of the encryption module to use.  Default: $SHOP_CRYPTO.
986
987 =item crypt_signing_id
988
989 Id of the key to sign the order email with.  If this is non-empty then
990 the email is signed even if [basic].sign is false.  Default:
991 $SHOP_SIGNING_ID.
992
993 =item crypt_gpg
994
995 Path to the GnuPG program.  Default: $SHOP_GPG
996
997 =item crypt_passphrase
998
999 Passphrase of the key used to sign the email.  Default:
1000 $SHOP_PASSPHRASE.
1001
1002 =item show_card_type
1003
1004 If true, request the card type when requesting credit card
1005 information.  Default: False.
1006
1007 =item cart_entry_limit
1008
1009 Maximum number of entries in the cart.  This limits the number of
1010 distinct products (with options) in the cart, not the total
1011 quantities.  Default: Unlimited.
1012
1013 =item currency_code
1014
1015 The shop currency as a 3-letter currency code.  Default: AUD.
1016 Currencies other than "AUD" aren't supported by most of the system.
1017
1018 =item country_code
1019
1020 Set to non-zero if you're using country codes in the order country
1021 field.  If this is set then the delivCountry is supplied as is to
1022 various parts of the system, otherwise it is translated from a country
1023 name to a country code.  Default: 0.
1024
1025 =item require_fields
1026
1027 A comma separated list of extra fields to require during checkout.
1028 This is in addition to the usual fields required during checkout.
1029 Default: none.
1030
1031 =item require_delivery
1032
1033 If true, and the C<need_delivery> CGI parameter is true, treat the
1034 following delivery fields as required during checkout: delivFirstName,
1035 delivLastName, delivStreet, delivSuburb, delivPostCode and delivCountry.
1036 Default: true.
1037
1038 =item require_delivery_fields
1039
1040 If C<require_delivery> is true, and the C<need_delivery> CGI parameter
1041 is true, add the comma separated fields listed here to the required
1042 checkout fields list.  Default: none.
1043
1044 =back
1045
1046 =head2 [shipping]
1047
1048 =over
1049
1050 =item couriers
1051
1052 A space-separated list of modules under Courier::, e.g. "Fastway::Road
1053 AustraliaPost::Air". These will be made available as shipping methods
1054 on the checkout page.
1055
1056 =item quoted
1057
1058 If true then a default "Quote shipping charges later" shipping method
1059 will be added to the shipping methods list.
1060
1061 =item sourcepostcode
1062
1063 The post code from which products are shipped.
1064
1065 =item fastwayfranchisee
1066
1067 The name of the Fastway franchisee used to ship products from the
1068 sourcepostcode.
1069
1070 =item fastwayfranchiseecode
1071
1072 The Fastway franchisee code for the customer, if any.
1073
1074 =back
1075
1076 =head2 [Shop Order Validation]
1077
1078 This section can contain extra order validation information, including
1079 specifying required fields, display names and extra validation rules.
1080
1081 =head2 [fields]
1082
1083 =over
1084
1085 =item title_size
1086
1087 The maximum length of the article title field.  Default: 255.  Should
1088 not be set higher than this unless you change the database schema.
1089
1090 =back
1091
1092 =head2 [interest]
1093
1094 Controls the interest.pl script.
1095
1096 =over
1097
1098 =item notify
1099
1100 Email address that is notified of the interest.  Defaults to $SHOP_FROM.
1101
1102 =back
1103
1104 =head2 [debug]
1105
1106 Used for debugging.
1107
1108 =over
1109
1110 =item logon_cookies
1111
1112 When a user logs on, and the site url is different to the secure url
1113 BSE attempts to refresh to the other "side" of the site to set the
1114 same cookie.
1115
1116 BSE does some simple comparisons to attempt to determine whether the
1117 logon form was triggered on the secure side of the site (possibly from
1118 the shop) or on the insecure side.  Since CGI doesn't necessarily give
1119 us all the information required, it's possible it will guess wrong.
1120
1121 Setting this option to 1 will enable debugging information sent to
1122 standard error, which will be sent to the error log on Apache.  This
1123 probably isn't useful on IIS.
1124
1125 =item file_unlink
1126
1127 Reports errors to STDERR (hence to the error log on Apache) if there
1128 is a problem deleting the actual file when an attached file is
1129 removed.
1130
1131 =item mail_encryption
1132
1133 Reports debugging information to standard error while encrypting your
1134 mail.
1135
1136 =item cookies
1137
1138 Reports cookies received from the browser and sent to the browser to
1139 STDERR (hence to the error log on Apache.)
1140
1141 =item dump_session
1142
1143 If nonzero the session hash is dumped to STDERR after it is retrived
1144 from the database.
1145
1146 =item subscription_expiry
1147
1148 If non-zero then subscription expiry date calculations are dumped to
1149 STDERR.
1150
1151 =item jit_dynamic_regen
1152
1153 If non-zero then information about jit_dynamic_regen is sent to
1154 STDERR.
1155
1156 =item ifUserCan
1157
1158 If non-zero then the ifUserCan tag will output some trace information
1159 to STDERR.
1160
1161 =item trace_noimpl
1162
1163 Enables some trace messages from tags that return an ENOIMPL
1164 exception.  This can be useful for tracking down why a tag isn't being
1165 replaced.  This will produce a lot of output during page regeneration.
1166
1167 =back
1168
1169 =head2 [uri]
1170
1171 Contains various URIs.
1172
1173 This is underused, so don't rely on it yet.
1174
1175 =over
1176
1177 =item articles
1178
1179 =item cgi
1180
1181 The URI to the CGI directory.  Default: /cgi-bin
1182
1183 =item dist_images
1184
1185 The URI where images included with BSE can be found.
1186
1187 This includes images such as F<trans_pixel.gif> and C<admin/error.gif>.
1188
1189 Default: C</images>
1190
1191 =item images
1192
1193 The URI where managed images are kept which should correspond to
1194 C<images> in C<[paths]>.
1195
1196 Default: C</images> (from C<$Constants::IMAGES_URI>)
1197
1198 =item scalecache
1199
1200 The URL to the directory represented by scalecache.  Defaults to
1201 I<[uri].images>F</scaled>.
1202
1203 =item public_files
1204
1205 The URL to the directory configured as I<[paths].public_files>.
1206
1207 =item shop
1208
1209 =back
1210
1211 =head2 [articles]
1212
1213 This will provide translations from symbolic names to article ids.
1214
1215 Currently this is used for converting article ids in the access
1216 control code, and for looking up the id of the shop.
1217
1218 =head2 [printable type]
1219
1220 If the user supplies a template name to printable.pl then you can use
1221 a different content type by adding an entry to this section.  The key
1222 is the template name, and the value is the full content type.
1223
1224 =head2 [search index scores]
1225
1226 This section is used when generating the search index to override the
1227 default scores for each field in the articles.
1228
1229 The default scores are:
1230
1231   Field           Score  Notes
1232   -----           -----  -----
1233   title             5
1234   body              3
1235   keyword           4
1236   pageTitle         5
1237   author            4
1238   summary           0
1239   description       0    Products only
1240   product_code      0    Products only
1241   file_displayName  2    displayName for files
1242   file_description  2    description for files
1243   file_notes        1    notes for files
1244
1245 =head2 [article flags]
1246
1247 =head2 [product flags]
1248
1249 =head2 [catalog flags]
1250
1251 Flags that can be set for articles, products and catalogs
1252 respectively.  Note that flags for articles are also visible in
1253 products and catalogs.
1254
1255 All flag Ids are single letters or digits.  Uppercase letters are
1256 reserved for use by BSE internally, leaving lower-case letters and
1257 digits for your own use.
1258
1259 Use the id of the flag as the key, and a description of the flag as
1260 it's value.
1261
1262 =head2 [article uris]
1263
1264 Each key is an article id, the values are base URIs to store the HTML
1265 form of those articles and their children under.
1266
1267 =head2 [protect link]
1268
1269 The keys are ids of articles that shouldn't have their link field
1270 overwritten.  The value should be a true value, but is otherwise
1271 ignored.
1272
1273 =head2 [datadump]
1274
1275 =over
1276
1277 =item to
1278
1279 The recipient for the data dump email sent by datadump.pl. Default:
1280 $DATA_EMAIL.
1281
1282 =item from
1283
1284 the From for the data dump email sent by datadump.pl.  Default:
1285 $SHOP_FROM.
1286
1287 =back
1288
1289 =head2 [site users]
1290
1291 Configuration for site users.
1292
1293 =over
1294
1295 =item nopassword
1296
1297 If this is set to true then no passwords are required during
1298 registration, a confirmation email is sent immediately upon
1299 registration and that confirmation email contains a link the user can
1300 use to manage their details.
1301
1302 This option has some security concerns since it can leave links to the
1303 user's information in the browser history.  This option is not
1304 recommended.
1305
1306 You cannot use this to control access to the shop.
1307
1308 =item require_name1
1309
1310 =item require_name2
1311
1312 =item require_street
1313
1314 =item require_suburb
1315
1316 =item require_state
1317
1318 =item require_postcode
1319
1320 =item require_telephone
1321
1322 =item require_facsimile
1323
1324 =item require_country
1325
1326 =item require_title
1327
1328 =item require_organization
1329
1330 Set these to true to require the corresponding field during
1331 registration, and to keep it required after modification.  Default:
1332 false.
1333
1334 If you enable any of these, you should enable C<info_on_register> as
1335 well, or modify the registration template to include the given fields.
1336
1337 =item display_I<field name>
1338
1339 Controls how the given field is displayed in error messages.  If you
1340 change the field names on the registration and/or options forms you
1341 should probably change them here too.  Default: internal field name
1342 with the first character converted to upper-case.
1343
1344 =item info_on_register
1345
1346 If this is set then the user info is prompted for during user
1347 registration.  The information still isn't required unless the
1348 appropriate require_I<field> option is set.  Default: false.
1349
1350 =item register_refresh
1351
1352 The default URL to refresh to on completing registration if no r
1353 parameter is supplied.
1354
1355 =item subscribe_all
1356
1357 If this is set then the subcription checkboxes are all checked on
1358 registration by default.  Default: false.
1359
1360 The user will only receive the subscriptions if they leave them checked
1361 and follow the link in the confirmation email.
1362
1363 =item subscribe_I<id>
1364
1365 Where I<id> is the number identifying a subscription.  If this is set
1366 then the subscription checkbox for that subscription will be checked
1367 by default on the registration form.  Default: false.
1368
1369 The user will only receive the subscriptions if they leave it checked
1370 and follow the link in the confirmation email.
1371
1372 You can get the I<id> of a subcription by looking at the Edit link on the
1373 subscriptions management page, the number after "id=" is the id.
1374
1375 =item billing_on_main_opts
1376
1377 If set to zero then user billing options will be managed on a separate
1378 page.  This is controlled by the user/options_base.tmpl template.
1379
1380 =item user_register
1381
1382 If set to zero then users cannot register themselves.  Default: true,
1383 allowing users to register themselves.
1384
1385 =item notify_register
1386
1387 If true then an email is sent when a new user registers on your site.
1388 The email address sent to is the first set of [site
1389 users].notify_register_email, [shop].from or $SHOP_FROM from
1390 Constants.pm
1391
1392 No email is sent if a new user is created from the administration user
1393 interface.
1394
1395 See also: notify_register_email, notify_register_subject.
1396
1397 =item notify_register_email
1398
1399 The email to sent the registration notification too.  See
1400 notify_register above.
1401
1402 =item notify_register_subject
1403
1404 The subject of the notification email sent when a new user registers.
1405 Any {I<field>} is replaced with the given field from the registered
1406 user.  See notify_register above.
1407
1408 Default: New user {userId} registered
1409
1410 =item notify_register_customer
1411
1412 If non-zero then email id C<notify_register_customer> will be sent to
1413 new user on registration.  By default this uses template
1414 user/email_register, subject "Thank you for registering" which can be
1415 overridden in [email notify_register_customer] or via the
1416 C<set_subject> tag.
1417
1418 =item notify_register_customer_admin
1419
1420 If non-zero then the behaviour described for
1421 C<notify_register_customer> will take place when a new member is added
1422 by an administrator.  Defaults to the value of
1423 C<notify_register_customer>.
1424
1425 =back
1426
1427 =head2 [payment type names]
1428
1429 This section and [payment type descs] are used to configure new
1430 paymeny type ids.
1431
1432 The key is the integer representing the payment type.  The value is
1433 the name used in tags for checking the payment type.
1434
1435 You can also add a description (currently unused) to [payment type
1436 descs].
1437
1438 You should use numbers starting from 10 to avoid conflicts with future
1439 BSE payment types.
1440
1441 =head2 [payment type descs]
1442
1443 See [payment type names].
1444
1445 =head2 [payment type required]
1446
1447 Set the key given by the payment type id to a value of a
1448 comma-separated list of fields required for that payment type.
1449
1450 =head2 [help style I<style-name>]
1451
1452 This type of configuration section is used to set values for a style
1453 of help icon.  Only the C<template> and C<prefix> values are used
1454 directly by the code, the others are used by the default helpicon
1455 templates.
1456
1457 =over
1458
1459 =item prefix
1460
1461 The URI to the help files for this style.  Default: /help/ in style
1462 "user", /admin/help/ in style "admin".
1463
1464 =item template
1465
1466 The template used to produce the icon.  Default: helpicon in style
1467 user, admin/helpicon in style "admin".
1468
1469 =item icon
1470
1471 URI to the help icon image.   Default: /images/admin/help.gif
1472
1473 =item iconwidth
1474
1475 The width of the help icon image.  Default: 16
1476
1477 =item iconheight
1478
1479 The height of the help icon image.  Default: 16
1480
1481 =back
1482
1483 If you just want to change the help icon image for user help icons you
1484 might do:
1485
1486   [help style user]
1487   icon=/images/help.gif
1488
1489 =head2 [affiliate]
1490
1491 =over
1492
1493 =item allowed_referer
1494
1495 A semi-colon (;) separated list of referer domains that are allowed to
1496 link to the C<a_set> target of L<affiliate.pl>.
1497
1498 If the user's browser supplies a referer header then it will be
1499 checked against this list.
1500
1501 =item require_referer
1502
1503 If this is set then the C<a_set> target of L<affiliate.pl> will
1504 require that the user's browser supply a Referer header.
1505
1506 =item default_refresh
1507
1508 If no C<r> parameter is supplied to the C<a_set> target of
1509 L<affiliate.pl> then this is used as the default refresh.
1510
1511 Default: the site base url.
1512
1513 =item subscription_required
1514
1515 This is either the numeric or text of a subscription for which the
1516 affiliate must have an active subscription.
1517
1518 =item flag_required
1519
1520 A single letter flag which the site administrator must set for the
1521 affiliate page to be displayed for the given member.
1522
1523 =item set_cookie
1524
1525 If this is set then affiliate.pl will set the named cookie to the
1526 affiliate id.
1527
1528 =item other_cookies
1529
1530 This is a comma-separated list of other cookies that should be set by
1531 the a_set target.  The values for the cookies should be passed to the
1532 a_set target.  For example with:
1533
1534   [affiliate]
1535   other_cookies=alpha,beta
1536
1537 if the url:
1538
1539   http://your.site.com/cgi-bin/affiliate.pl?a_set=1&id=someid&alpha=1&beta=2&gamme=3
1540
1541 is accessed, then the cookie alpha is set to "1", beta is set to "2".
1542 The cookie gamma will not be set since it's not listed.
1543
1544 =item linkbaseurl
1545
1546 Used as the link base URL for the afflink.tmpl side bar template when
1547 an affiliate id is set.  Default: example.com
1548
1549 =item linkbasedesc
1550
1551 Used at the text of the link for the afflink.tmpl side bar template
1552 when an affiliate id is set.  Default: Your Site.
1553
1554 =item linkdefurl
1555
1556 Used as the link URL for the afflink.tmpl side bar template when an
1557 affiliate id is not set.  Default: example.com
1558
1559 =item linkdefdesc
1560
1561 Used as the text of the link for the afflink.tmpl side bar template
1562 when an affiliate id is not set.  Default: Our site
1563
1564 =back
1565
1566 =head2 [BSE Siteuser Images]
1567
1568 Each key is the id of a member image, with a corresponding [BSE
1569 Siteuser Image I<image_id>] section.  The values are ignored.
1570
1571 =head2 [BSE Siteuser Image I<image_id>]
1572
1573 Provides information about a single member image "template".
1574
1575 =over
1576
1577 =item description
1578
1579 Short description on the image, like "Logo".  Used in error messages.
1580
1581 =item help
1582
1583 Longer description of the image.  Accessible with the member_image tag.
1584
1585 =item minwidth
1586
1587 =item minheight
1588
1589 =item maxwidth
1590
1591 =item maxheight
1592
1593 The minimum and maximum dimensions of the image.
1594
1595 =item widthsmallerror
1596
1597 =item heightsmallerror
1598
1599 =item widthlargeerror
1600
1601 =item heightlargeerror
1602
1603 Error messages displayed in the when the image is outside the
1604 configured dimensions.
1605
1606 =item largeerror
1607
1608 =item smallerror
1609
1610 Default error messages for the above.
1611
1612 =item maxspace
1613
1614 Maximum storage the image can use in bytes.  Default: 1000000.
1615
1616 =item spaceerror
1617
1618 Error message displayed if the image uses too much storage.
1619
1620 =back
1621
1622 =head2 [editor]
1623
1624 Various editor settings.
1625
1626 =over
1627
1628 =item allow_thumb
1629
1630 If this is non-zero the system will attempt to load the configured
1631 thumbnail class, and put thumbnail images on the image manager page
1632 rather than full-size images.  Default: off
1633
1634 =item thumbs_class
1635
1636 The name of a perl class that implement's BSE's thumbnail API.  At
1637 this point the only class that implements that is BSE::Thumb::Imager,
1638 supplied with BSE.  Default: None
1639
1640 =item default_thumbnail
1641
1642 URI to the default thumbnail image.  This is presented when the
1643 runtime production of a thumbnail image fails.
1644
1645 =item default_thumbnail_width
1646
1647 =item default_thumbnail_height
1648
1649 Dimensions of the default thumbnail image.
1650
1651 =item default_thumbnail_alt
1652
1653 Alt text for the default thumbnail image.
1654
1655 =item check_modified
1656
1657 If this is true then BSE will check the value of the lastModified
1658 parameter passed against the value in the article.  If these don't
1659 match the article isn't saved and is redisplayed with an error
1660 message.  This provides simple protection against one user saving
1661 changes over those made by another.
1662
1663 =back
1664
1665 =head2 [thumbnails]
1666
1667 =over
1668
1669 =item max_width
1670
1671 =item max_height
1672
1673 =item max_pixels
1674
1675 Default values for the thumbimage tag.
1676
1677 =back
1678
1679 =head2 [includes]
1680
1681 Each value is used as the relative or absolute name of a file or
1682 directory to load more configuration data from.
1683
1684 The keywords must remain unique.
1685
1686 Only the [includes] section from bse.cfg itself is used to locate more
1687 configuration data.
1688
1689 If the value references a directory, all files with an extension of
1690 C<.cfg> are read for configuration data.
1691
1692 The order the files are read (which later files overriding older
1693 files) is:
1694
1695 =over
1696
1697 =item 1.
1698
1699 bse.cfg is read
1700
1701 =item 2.
1702
1703 the entries in [includes] are sorted alphabetically (or rather
1704 asciily), so an entry with key "A" is read before one with key "B",
1705 one with key "01" is read before "02", but key "10" would be read
1706 I<before> key "2".
1707
1708 =item 3.
1709
1710 if an entry is a file then that is read and the values merged.
1711
1712 =item 4.
1713
1714 if an entry is a directory, then that is scanned and the files found
1715 read alphabetically as above.
1716
1717 =back
1718
1719 =head2 [error_img]
1720
1721 This is used to configure the error icon displayed next to fields that
1722 fail validation.
1723
1724 =over
1725
1726 =item image
1727
1728 URI to the image file.
1729
1730 =item width
1731
1732 =item height
1733
1734 The width and height of the error icon image.
1735
1736 =back
1737
1738 =head2 [site user flags]
1739
1740 Flags that can be set for site users.
1741
1742 All flag Ids are single letters or digits.  Uppercase letters are
1743 reserved for use by BSE internally, leaving lower-case letters and
1744 digits for your own use.
1745
1746 Use the id of the flag as the key, and a description of the flag as
1747 it's value.
1748
1749 =head2 [article defaults]
1750
1751 =head2 [catalog defaults]
1752
1753 =head2 [product defaults]
1754
1755 These sections contain defaults values for the corresponding article
1756 types.
1757
1758 Each key is the name of a column for the article type.
1759
1760 If an entry is not found in [catalog defaults] then [article defaults]
1761 is also checked.
1762
1763 If an entry is not found in [product defaults] then [article defaults]
1764 is also checked.
1765
1766 These sections are checked B<after> the C<[children of >I<id>C<]> and
1767 C<[level >I<level>C<]> sections.
1768
1769 These defaults are used when creating an article where no value is
1770 supplied, they can also be accessed via the <:default I<name>:> tag.
1771
1772 =head2 [newsletter filters]
1773
1774 Contains C<criteria>I<index> entries starting from C<criteria1>, then
1775 C<criteria2>, etc.
1776
1777 Each entry consists of a filter class name, followed by a ; followed
1778 by data passed to that filter.
1779
1780   ; user the original SQL based filter, configured from 
1781   ; section [foo]
1782   criteria1=BSE::NLFilter::SQL;foo
1783
1784 See the documentation for each filter to configure the filters.
1785
1786 =head2 [Query Groups]
1787
1788 The key of each entry is the numeric identifier of a query group, the
1789 values are the name of the query group.  For example:
1790
1791   [query groups]
1792   1=some name
1793
1794   [query group some name]
1795   sql=select id from bse_siteusers where id = ? and name1 like '%some%'
1796
1797 Each entry also has a corresponding [Query Group I<name>] section.
1798
1799 =head2 [query group I<name>]
1800
1801 This section corresponds to an entry in [Query Groups].
1802
1803 =over
1804
1805 =item sql
1806
1807 This is an SQL statement.  One placeholder is required and is passed
1808 the siteuser id (primary key) of the user to be checked.  If this
1809 query returns I<any> rows then the user is considered part of the
1810 group.
1811
1812 =back
1813
1814 =head2 [template types]
1815
1816 Each key is a template name, the value is the content type to be used
1817 when displaying the template dynamically.
1818
1819 =head2 [template descriptions]
1820
1821 Each key is a template name, the value is a description used in the
1822 template dropdown for that template.
1823
1824 =head2 [body class]
1825
1826 This section defines CSS class names for BSE's body text link tags.
1827 The key is the tag name, the value is the CSS class to be used.
1828
1829 By default the class used is the same as the name of the tag, but you
1830 can switch this off by adding an entry setting the class to the empty
1831 string, for example:
1832
1833   ; no class attribute for any of the links
1834   [body class]
1835   link=
1836   poplink=
1837   doclink=
1838   popdoclink=
1839
1840 You can set p here too to set the class for paragraphs generated as
1841 body text.  By default no class is set.
1842
1843 =head2 [popimage]
1844
1845 Controls the behaviour of the window displayed by the popimage[] body
1846 text tag.  If the Javascript for this has been customized then this
1847 may not apply.
1848
1849 =over
1850
1851 =item extrawidth
1852
1853 =item extraheight
1854
1855 Extra width and height for the window beyond the size of the image.
1856 Default: no extra width or height.
1857
1858 =item popmiddle
1859
1860 If set to non-zero popimage[] will attempt to centre the popup within
1861 the current window.  Default: 0.
1862
1863 =back
1864
1865 =head2 [inpho]
1866
1867 This is used to configure the DevHelp::Payments::Inpho module.
1868
1869 =over
1870
1871 =item test
1872
1873 If this is set then the test parameters are used instead of the
1874 product values.
1875
1876 =item url
1877
1878 The URL to process requests through.  
1879
1880 Default: https://extranet.inpho.com.au/cc_ssl/process
1881
1882 =item user
1883
1884 Inpho supplied user name.
1885
1886 =item password
1887
1888 Inpho supplied password.
1889
1890 =item test_url
1891
1892 The URL to process test requests through.
1893
1894 =item test_user
1895
1896 The user to supply to test requests.
1897
1898 =item test_password
1899
1900 The password to supply to test requests.
1901
1902 =back
1903
1904 =head2 [custom]
1905
1906 This section controls whether some custom class methods are called:
1907
1908 =over
1909
1910 =item saveopts
1911
1912 If this is non-zero then siteuser_saveopts is called.
1913
1914 =back
1915
1916 =head2 [levelI<level> menus]
1917
1918 Where I<level> is the article level at which the defined menu options will be available.
1919 Configure each menu value and description as I<key> and I<value>.
1920
1921 =over
1922
1923 For example:
1924
1925   [level1 menus]
1926   0=Default
1927   1=Sidebar
1928   2=Footer
1929
1930 To create a menus using such values, use the "allkids_of" iterator "filter" option.
1931
1932 For example:
1933
1934   <:iterator begin allkids_of -1 filter: [menu] == 2 :>
1935
1936 =back
1937
1938 =head2 [title alias]
1939
1940 Enable the "titleAlias" article field and set which level it will be available.
1941
1942 =over
1943
1944 =item levelI<level>
1945
1946 Where I<level> is the article "level" for which the "titleAlias" field should be enabled.  To enable
1947 set the value to non-zero.
1948
1949 For example:
1950
1951   [title alias]
1952   level1=1
1953
1954 The "titleAlias" can be used as an alternate "short" title for the given article, especially useful
1955 for space critical iterated menus.  A template conditional can be used to display the "titleAlias" 
1956 in place of the article "title" when appropriate.
1957
1958 =back
1959
1960 =head2 [thumb geometries]
1961
1962 Each key represents a geometry identifier for use by the thumbimage[],
1963 gthumbimage[] body text tags and the <:thumbimage ...:>, <:gthumbimage
1964 ...:>, <:dthumbimage ...:> template tags.
1965
1966 The key is the geometry identifier, the value is the geometry string
1967 as follows.
1968
1969 The geometry string consists of:
1970
1971 =over
1972
1973 =item *
1974
1975 dimensions
1976
1977 =item *
1978
1979 crop flag - if present
1980
1981 =item *
1982
1983 optional fill
1984
1985 =back
1986
1987 The dimensions can be in any of the following forms:
1988
1989 =over
1990
1991 =item *
1992
1993 <width>x<height> - the desired maximum width and height. eg 200x150
1994
1995 =item *
1996
1997 <width>x - the desired width, with the height calculated
1998 proportionally based on the source image size
1999
2000 =item *
2001
2002 x<height> - the designed height, with the width calculated
2003 proportionally based on the source image size.
2004
2005 =item *
2006
2007 <size> - the desired maximum size in both directions. so "200" is
2008 equivalent to "200x200"
2009
2010 =back
2011
2012 The crop flag is a single letter "c", if present then the image should
2013 be scaled so the smaller dimension matches the requested size, and the
2014 longer dimension will be cropped to fit.
2015
2016 The fill if present is: fill(color) where color is a color recognized
2017 by the underlying graphics implementation.  This should be at least
2018 hex web colors without the #, eg fill(FF0000) will fill with red.
2019
2020 =head2 [thumb classes]
2021
2022 Each key represents a geometry identifier for use by the thumbimage[],
2023 gthumbimage[] body text tags and the <:thumbimage ...:>, <:gthumbimage
2024 ...:>, <:dthumbimage ...:> template tags.
2025
2026 The value is used as the class for the generated img tag.
2027
2028 =head2 [targets]
2029
2030 Each value represents a handler or script name for the <:dyntarget
2031 I<script> I<target> ...:> tag.
2032
2033 Each key has a TARGET version and a no-TARGET version, with the key
2034 suffixed with C<_n>.
2035
2036 The default C<nuser> target is C</cgi-bin/nuser.pl/user/TARGET>.  The
2037 default no-target C<nuser> is C</cgi-bin/nuser.pl/user>.
2038
2039 For other targets the default is
2040 C</cgi-bin/>I<script>C<.pl?a_TARGET=1> and
2041 C</cgi-bin/>I<script>C<.pl>.
2042
2043 The string C<TARGET> is replaced with the target specified in the
2044 dyntarget tag.
2045
2046 This, along with dyntarget is intended to allow a more "Web 2.0" type
2047 of access to BSE.  eg. you might set:
2048
2049   [targets]
2050   shop=/xshop/TARGET
2051   shop_x=/xshop/
2052
2053 and have a rewrite rule:
2054
2055   RewriteRule ^/xshop/(.*)$ /cgi-bin/nuser.pl/shop/$1 [PT]
2056
2057 =head2 [popimage class I<classname>]
2058
2059 This defines the settings for a class of images generated by the
2060 popimage[] and gpopimage[] body text markup tags.  For example, the
2061 settings for C<popimage[imageid|foo]> can be found in section
2062 C<[popimage class foo]>.
2063
2064 =over
2065
2066 =item html
2067
2068 The html generated for this class.  Tags of the form
2069 C<{>I<identifier>C<}> are replaced, where I<identifier> can be
2070 C<inline_> or C<outline_> followed by an image field name, for example
2071 C<inline_src> is the URL to the inline image.
2072
2073 Default: <a href="{outline_src}" rel="lightbox[id]" target="_blank"><img src="{inline_src}" alt="{inline_alt}" width="{inline_width}" height="{inline_height}" border="0" /></a>
2074
2075 The default may be tuned as needed.
2076
2077 =item inline
2078
2079 The inline image geometry.  Default: editor (the value used for
2080 thumbnails on the admin side)
2081
2082 =item outline
2083
2084 The outline image geometry.  If no value is supplied then the original
2085 image values are used.
2086
2087 =back
2088
2089 =head2 [mail resources]
2090
2091 Each key is the identifier of a file that can be attached to
2092 BSE::ComposeMail emails.  The value is comma separated filename,
2093 content type, inline status.
2094
2095 The files are searched for through the template search mechanism, so
2096 the filename can be relative to either the master or local templates
2097 directories.
2098
2099 If the content type is not supplied, if the filename end in gif, png
2100 or jpg the appropriate content type is used, otherwise
2101 application/octet-stream.
2102
2103 If the inline status is not supplied then images are considered
2104 inline, and other files arent.
2105
2106 =head2 [shop registration]
2107
2108 Each key represents a message id from attempts to checkout.  Except
2109 the all key which covers all cases.
2110
2111 If the C<all> key or the message id key is non-zero then the checkout
2112 page will redirect to registration instead of login if the cart or
2113 configuration requires that the user be logged in.
2114
2115 =head2 [template I<template-name>]
2116
2117 Settings for articles based on a particular template.
2118
2119 =over
2120
2121 =item no_cache_dynamic
2122
2123 Controls whether a cache-control: no-cache header will be produced.
2124 Can be overridden with the A and B article flags.  If not set the
2125 value of [article].no_cache_dynamic is used.
2126
2127 =back
2128
2129 =head2 [article]
2130
2131 Global settings for articles.
2132
2133 =over
2134
2135 =item no_cache_dynamic
2136
2137 Controls whether a cache-control: no-cache header will be produced.
2138 Can be overridden with the A and B article flags or [template
2139 I<template-name>].no_cache_dynamic.  If not set the value of
2140 [basic].no_cache_dynamic is used.
2141
2142 =back
2143
2144 =head2 [recaptcha]
2145
2146 For the <:recaptcha:> tag currently only used for fmail.pl.
2147
2148 =over
2149
2150 =item api_public_key
2151
2152 =item api_private_key
2153
2154 The public and private key you receive when you register with reCAPTCHA.
2155
2156 =item error_I<error_code>
2157
2158 Replace the error message for the given I<error_code> where
2159 I<error_code> is the reCAPTCHA error code
2160 (eg. "incorrect-captcha-sol") with dash replaced by underscore.
2161
2162 eg.
2163
2164   error_incorrect_captch_sol=VERY BAD INPUT
2165
2166 =back
2167
2168 =head2 [global file metadata]
2169
2170 Each key represents an item of metadata for files attached to
2171 articles.
2172
2173 The values are ignored.
2174
2175 For each key, extra information is defined in the [file metadata
2176 I<name>] section.
2177
2178 =head2 [file metadata I<name>]
2179
2180 Definition for the file metadata item I<name>.
2181
2182 =over
2183
2184 =item *
2185
2186 title - descriptive name of the metadata.  Defaults to I<name>.
2187
2188 =item *
2189
2190 rules - validation rules, separated by ;.  Custom rules can be defined
2191 in [file metadata validation].
2192
2193 =item *
2194
2195 ro - if non-zero the metadata cannot be modified directly by the admin
2196 (applications can still generate it). Default: writable.
2197
2198 =item *
2199
2200 type - the data type of the metadata, any of string, text, enum,
2201 integer, real, image.  If this is enum values must be defined and
2202 labels should be.  Default: string.
2203
2204 The types are:
2205
2206 =over
2207
2208 =item *
2209
2210 string - single line of text
2211
2212 =item *
2213
2214 text - one or more lines of text
2215
2216 =item *
2217
2218 integer - whole number
2219
2220 =item *
2221
2222 real - number with decimal points
2223
2224 =item *
2225
2226 enum - select from a list of possible values.
2227
2228 =item *
2229
2230 image - image file.
2231
2232 =back
2233
2234 =item *
2235
2236 values - semi-colon separated list of values for this metadata.
2237
2238 =item *
2239
2240 labels - semi-colon separated list of labels for the values
2241
2242 =item *
2243
2244 help - help html to display for the metadata
2245
2246 =item *
2247
2248 data_name - (images only) the key to use to store the image data.
2249 Default: I<name>_data.
2250
2251 =item *
2252
2253 width_name - (images only) the key to use to store the image width.
2254 Default: I<name>_width.
2255
2256 =item *
2257
2258 height_name - (images only) the key to use to store the image height.
2259 Default: I<name>_height.
2260
2261 =item *
2262
2263 cond - a perl expression indicating whether the metadata should be
2264 prompted for, for this file.  $file is the file object.  Default: 1.
2265
2266 =item *
2267
2268 unit - text displayed after the entry box for the metadata.  Default:
2269 empty.  Useful for including a unit ("pixels") or format help
2270 ("hh:mm").
2271
2272 =back
2273
2274 =head2 [session cleanup]
2275
2276 Controls the processing of the bse_session_clean.pl script.
2277
2278 =over
2279
2280 =item *
2281
2282 days - the minimum age in days of sessions to be removed.  Default: 30.
2283
2284 =item *
2285
2286 per - the number of records to remove per SQL delete request.
2287 Default: 1000.
2288
2289 =item *
2290
2291 count - the number of SQL delete requests to perform, maximum.
2292 Default: 1000.
2293
2294 =item *
2295
2296 optimize - whether to perform a table optimization after deleting
2297 records.  Default: 1 (set to 0 to skip optimization)
2298
2299 =back
2300
2301 =head2 [nightly work]
2302
2303 Controls the bse_nightly.pl script.
2304
2305 =over
2306
2307 =item *
2308
2309 jobs - a comma separated list of BSE background processes to run when
2310 bse_nightly.pl is run.  Default: bse_session_clean
2311
2312 =item *
2313
2314 I<other keys> - each key is a sort key, and the value is a single
2315 background task name.  This allows add-ons to setup extra tasks
2316 without overwriting each other.  The sugessted key format is:
2317
2318   99 - two digit priority - 00 is executed first, 99 last
2319   package-name - name of package the task is for
2320   unique - extra text to make the key unique, if necessary
2321
2322 =back
2323
2324 =head2 [cache]
2325
2326 Parameters controlling where cached information - eg. file upload
2327 progress is stored.
2328
2329 =over
2330
2331 =item *
2332
2333 class - the BSE::Cache compatible cache class.  See the documentation
2334 of BSE::Cache::Cache, BSE::Cache::CHI or BSE::Cache::Memcached.
2335
2336 =back
2337
2338 =head2 [db]
2339
2340 Database connection parameters.  These override the settings in
2341 Constants.pm which are deprecated.
2342
2343 =over
2344
2345 =item *
2346
2347 dsn - the DBI dsn used to connect to the database. Default:
2348 $Constants::DSN.
2349
2350 =item *
2351
2352 user - the logon to the database.  Default: $Constants::UN
2353
2354 =item *
2355
2356 password - the password for the user.  Default: $Constants::PW.
2357
2358 =item *
2359
2360 dbopts - a perl expression that should evaluate to a hash reference.
2361 Default: $Constants::DBOPTs, or an empty hashref.
2362
2363 =item *
2364
2365 class - the database wrapper class to use.  Default: BSE::DB::Mysql.
2366 No other values are currently supported.
2367
2368 =back
2369
2370 =head2 [extra a_config]
2371
2372 Defines extra configuration to be returned from the BSE system
2373 configuration.
2374
2375 Each key is the keyword in the returned JSON object.  If the key
2376 already exists it is not overwritten.
2377
2378 Each value is the name of a section in the BSE configuration.  The
2379 strings "{level}", "{generator}", "{parentid}", "{template}" are
2380 replaced with their values from the article that config is being
2381 requested for.
2382
2383 So:
2384
2385   [extra a_config]
2386   menu=level{level} menu
2387
2388   [level1 menu]
2389   alpha=One
2390   beta=Two
2391
2392 will include:
2393
2394   menu: { alpha: "One", beta: "Two" }
2395
2396 in the returned configuration
2397
2398 =head2 [cookie names]
2399
2400 This section maps BSE's default cookie names to alternate names.  This
2401 can be useful if you have two BSE sites under the same domain and need
2402 to ensure they use different cookies.
2403
2404 eg.
2405
2406   [cookie names]
2407   userid=altuserid
2408
2409 =head2 [siteuser updates]
2410
2411 Each key identifies an update specification for userupdate.pl, the
2412 value is a description of the specification.
2413
2414 See L<< [siteuser update I<specid>] >> for the rest of the import
2415 specification.
2416
2417
2418 =head2 [siteuser update I<specid>]
2419
2420 Currently contains only a single key:
2421
2422 =over
2423
2424 =item *
2425
2426 fields - a semi-colon separated list of fields to import.  Must
2427 contain one of C<id> or C<userId> which is used as a key to identify
2428 the user to update.  An C<x> entry is a field to ignore.  Some fields,
2429 such as C<confirmed> may not appear in this list.
2430
2431 =back
2432
2433 =head2 [paypal]
2434
2435 Configuration for BSE's PayPal integration.
2436
2437 It shouldn't be necessary to change any of the URLs.
2438
2439 =over
2440
2441 =item *
2442
2443 test - if true, then the PayPal sandbox is used, and the configuration
2444 entries starting in C<test_> are used.  If false, PayPal is live, and
2445 configuration entries starting in C<live_> are used.  Default: 1.
2446
2447 =item *
2448
2449 test_api_username, test_api_password, test_api_signature - API
2450 credentials for test mode.  Required in test mode.
2451
2452 =item *
2453
2454 live_api_username, live_api_password, live_api_signature - API
2455 credentials for live mode.  Required for live mode.
2456
2457 =item *
2458
2459 test_ws_url - URL to make NVP requests through in test mode.  Default:
2460 https://api-3t.sandbox.paypal.com/nvp
2461
2462 =item *
2463
2464 test_refresh_url - PayPal URL to refresh to in test mode.  Default:
2465 https://www.sandbox.paypal.com/webscr
2466
2467 =item *
2468
2469 live_ws_url - URL to make NVP requests through in live mode.  Default:
2470 https://api-3t.paypal.com/nvp
2471
2472 =item *
2473
2474 live_refresh_url - PayPal URL to refresh to in live mode.  Default:
2475 https://www.paypal.com/cgibin/webscr
2476
2477 =back
2478
2479 =head2 [paypal custom]
2480
2481 Extra parameters supplied to the SetExpressCheckout API.  See the
2482 Express Checkout Advanced Features Guide (from PayPal) for details.
2483
2484 Some settings that may be useful:
2485
2486 =over
2487
2488 =item *
2489
2490 PAGESTYLE - the style of payment page to use from those listed in your
2491 account profile.
2492
2493 =item *
2494
2495 HDRIMG - https URL to an image to use in the payment page header.
2496
2497 =item *
2498
2499 HDRBACKCOLOR - a 6 hex digit color to use as the background of the
2500 payment page header.
2501
2502 =item *
2503
2504 HDRBORDERCOLOR - a 6 hex digit color to use as the border of the
2505 payment page header.
2506
2507 =back
2508
2509 =head2 [audit log]
2510
2511 =over
2512
2513 =item *
2514
2515 mail - if non-zero any emails sent through BSE::ComposeMail are logged
2516 in the audit log.  Default: 0.
2517
2518 =item *
2519
2520 mail_max_dump - if non-zero this is the size limit of the dump stored
2521 in the audit log when [audit log].mail is enabled.  Default: 50000.
2522
2523 =back
2524
2525 =head2 [audit log I<facility>]
2526
2527 Most commonly C<[audit log bse]>.  Controls whether given events or
2528 families of events are logged.
2529
2530 The key is one of:
2531
2532 =over
2533
2534 =item I<component>
2535
2536 =item I<component>C<:>I<module>
2537
2538 =item I<component>C<:>I<module>C<:>I<function>
2539
2540 =back
2541
2542 with the longer keys overriding the shorter keys, and defaulting to
2543 all actions being logged.
2544
2545 =head2 [mail audit log]
2546
2547 This enables sent when an event is logged in the audit log.  Warning:
2548 for common events this will result in large amounts of email.
2549
2550 =over
2551
2552 =item *
2553
2554 to - the email address to send the email to
2555
2556 =item *
2557
2558 emerg, alert, crit, error, warning, notice, info, debug - if present
2559 and true then events at these levels result in an email.  If the value
2560 contains an C<@> then the value is used as the recipient address.
2561
2562 =item *
2563
2564 I<facility>-I<component>
2565
2566 =item *
2567
2568 I<facility>-I<component>-I<module>
2569
2570 =item *
2571
2572 I<facility>-I<component>-I<module>-I<function>
2573
2574 Controls sending an email for specific events or families of events.
2575 If the value is true, send an email for that event.  If the value
2576 contains an C<@> then the value is used as the recipient address.
2577
2578 =back
2579
2580 with the longer keys overriding the shorter keys, and defaulting to
2581 all actions being logged.
2582
2583 =head2 [html tidy]
2584
2585 Contains options to pass to HTML::Tidy.  Anything not listed below is
2586 passed directly to HTML::Tidy->new.
2587
2588 =over
2589
2590 =item *
2591
2592 ignore_types - types of message to ignore separated by commas, any,
2593 all or none of info, warning, error.
2594
2595 =item *
2596
2597 ignore_text_I<key> - messages to ignore, I<key> is not used, just the
2598 value.
2599
2600
2601 =back
2602
2603 =head2 [email I<token>]
2604
2605 Controls emails sent via F<cgi-bin/admin/sendemail.pl>.
2606
2607 =over
2608
2609 =item *
2610
2611 template - plain text template
2612
2613 =item *
2614
2615 html_template - HTML template (defaults to the value of I<template>
2616 followed by C<_html>
2617
2618 =item *
2619
2620 subject - subject of the email, can be overridden with the
2621 C<set_subject> tag.
2622
2623 =item *
2624
2625 from - from email address, defaults to the shop from address
2626
2627 =item *
2628
2629 from_name - from name
2630
2631 =item *
2632
2633 allow_html - controls whether HTML is allowed.  By default this is
2634 based on the user's settings.
2635
2636 =back
2637
2638 =head2 [lost password]
2639
2640 =over
2641
2642 =item *
2643
2644 daily_limit - the number of recovery attempts permitted per day.
2645 Default: 3.
2646
2647 =item *
2648
2649 age_limit - the id included in the email is valid for this many days.
2650 Default: 7.
2651
2652 =back
2653
2654 =head2 [link replacement]
2655
2656 For formatted text, this is a list of URL prefixes to replace.
2657
2658 The key is a sort key, replacements are checked in alphabetical order.
2659
2660 The value is the original prefix, followed by ";", followed by the
2661 replacement.
2662
2663 Replacement is performed case-insenitively.  Regexp metacharacters
2664
2665 =head2 [article categories]
2666
2667 =over
2668
2669 =item *
2670
2671 ids - a comma separated list of category ids.  There are (currently)
2672 no restrictions on the contents of these ids, but alphanumerics are
2673 recommended to simplify templates.
2674
2675 =item *
2676
2677 I<id> - a description for a particular category id.  Overridden by the
2678 C<name> key in C<< [article category I<id>] >>.  Default: ucfirst of
2679 the id.
2680
2681 =back
2682
2683 =head2 [article category I<id>]
2684
2685 =over
2686
2687 =item *
2688
2689 name - name of the article category.
2690
2691 =back
2692
2693 Other keys may be used as desired, eg. to make it simpler to configure
2694 article behaviour based on the category.
2695
2696 =head2 [article menu]
2697
2698 This section can be used to add new menu items to the menu displayed
2699 on article edit pages.
2700
2701 The keys are used for sorting only.
2702
2703 The value is comma-separated:
2704
2705 =over
2706
2707 =item *
2708
2709 target script name
2710
2711 =item *
2712
2713 target identifier, to be set to 1 on making a request to the script.
2714
2715 =item *
2716
2717 the label for the item in the menu.
2718
2719 =back
2720
2721 eg.
2722
2723   sample,a_foo,Sample Item
2724
2725 will generate a link like:
2726
2727   <a href="/cgi-bin/admin/sample.pl?id=10&amp;a_foo=1">Sample Item</a>
2728
2729 where 10 is the id of the article being edited.
2730
2731 Keys with a prefix of C<bse_> are reserved for BSE internal use.
2732
2733 =head2 [undeletable articles]
2734
2735 Keys are the ids of articles that may not be deleted.
2736
2737 This applies if the value of the entry is a true perl value.
2738
2739   [undeletable articles]
2740   1=home page
2741   2=more home page
2742   ; article 3 is deletable
2743   3=
2744
2745 =head2 [dummy shipping methods]
2746
2747 Configures extra shipping methods only selectable from the order
2748 detail page.
2749
2750 Entries are sorted by value.
2751
2752 If the value contains a comma the text up to the comma is removed and
2753 the remains used as the label, otherwise the key is used as the label.
2754
2755 =head2 [article custom fields]
2756
2757 =head2 [product custom fields]
2758
2759 =head2 [catalog custom fields]
2760
2761 These can be used to define article, product and catalog custom fields
2762 respectively, in a similar manner to L<formmail>.
2763
2764 The field names are predefined, C<customDate1>, C<customDate2>,
2765 C<customInt1>, C<customInt2>, C<customInt3>, C<customInt4>,
2766 C<customStr1> and C<customStr2>, but are only active if a description
2767 is defined for the field:
2768
2769   [article custom fields]
2770   customInt1_description=Stock Level
2771
2772 =head2 [siteuser passwords]
2773
2774 Rules for validating (not verifying) site user passwords.  Possible
2775 keys are:
2776
2777 =over
2778
2779 =item *
2780
2781 C<length> - the minimum length of passwords.  This replaces
2782 C<minpassword> in C<[basic]>.
2783
2784 =item *
2785
2786 C<entropy> - the minimum password entropy as measured by
2787 L<Data::Password::Entropy>.
2788
2789 =item *
2790
2791 C<symbols> - if non-zero, the password must contain non-alphanumerics.
2792
2793 =item *
2794
2795 C<digits> - if non-zero, the password must contain digits.
2796
2797 =item *
2798
2799 C<mixedcase> - if non-zero, the password must contain both upper and
2800 lower case letters.
2801
2802 =item *
2803
2804 C<categories> - the number of categories out of 5 required out of
2805 symbols, digits, upper case, lower case and extended ASCII/Unicode.
2806 This should typically never be 5.
2807
2808 =item *
2809
2810 C<notuser> - the password and user name may not match each other
2811 case-insensitively.
2812
2813 =item *
2814
2815 C<notu5er> - the password may not match the user name
2816 case-insensitively, even with symbol replacement (e.g. "5" for "S".
2817
2818 =back
2819
2820 =head2 [admin user passwords]
2821
2822 Rules for validating (not verifying) administrative user passwords.
2823 See L</[siteuser passwords]> on the keys that can be set.
2824
2825 =head2 [site user lockouts]
2826
2827 Controls when accounts and IP addresses are locked out due to repeated
2828 site user authentication failures.
2829
2830 =over
2831
2832 =item *
2833
2834 I<account maximum failures> - the maximum number of login failures for
2835 a given account in I<account time period>.  A successful login of the
2836 account resets the count.  Default: 3.
2837
2838 =item *
2839
2840 C<account_time_period> - the number of minutes in which
2841 C<account_maximum_failures> login failures occurring will cause an
2842 account lock-out. Default: 10.
2843
2844 =item *
2845
2846 C<account_lockout_time> - the number of minutes to lock out an account
2847 that fails too many logins. Default: 60.
2848
2849 =item *
2850
2851 C<ip_maximum_failures> - the maximum number of login failures for a
2852 given IP address with-in C<ip_time_period>.  A successful login of any
2853 account at the IP address resets the count.  Default: 10.
2854
2855 =item *
2856
2857 C<ip_time_period> - the number of minutes in which
2858 C<ip_maximum_failures> login failures occurring causes an IP address
2859 lock-out. Default: 30.
2860
2861 =item *
2862
2863 C<ip_lockout_time> - the number of minutes to lock out an IP
2864 address that fails too many logins. Default: 120.
2865
2866 =item *
2867
2868 C<ip_maximum_failures2> - the maximum number of login failures for a
2869 given IP address with-in C<ip_time_period>.  A successful login of any
2870 account at the IP address I<does not reset> the count. Default: 50.
2871
2872 =item *
2873
2874 C<ip_lockout_time2> - the number of minutes to lock out an IP address
2875 that fails too many logins against C<ip_maximum_failure2>. Default:
2876 120.
2877
2878 =back
2879
2880 Note: an administrator unlocking an account resets the account lock
2881 count but has no effect on the IP address lock count.  An
2882 administrator unlocking an IP address resets both IP address lock
2883 counts, but has no effect on account lock counts.
2884
2885 =head2 [admin user lockouts]
2886
2887 Control account and IP address lockouts for admin user authentication.
2888
2889 See L</[site user lockouts]> for details of the configuration
2890 possible.
2891
2892 =head2 [pregenerate]
2893
2894 Defines templates to be generated as base templates.
2895
2896 Each entry is of the form:
2897
2898 =over
2899
2900 I<output-template>=I<profile-name>,I<input-template>
2901
2902 =back
2903
2904 where:
2905
2906 =over
2907
2908 =item *
2909
2910 I<output-template> - the output template name, stored in the directory
2911 defined by [paths].templates
2912
2913 =item *
2914
2915 I<profile-name> - used to select a section in the config file to load
2916 dummy article settings from, as C<< [I<profile-name> settings] >>.
2917
2918 =item *
2919
2920 I<input-template> - the source template to generate from.
2921
2922 =back
2923
2924 =head1 AUTHOR
2925
2926 Tony Cook <tony@develop-help.com>
2927
2928 =cut