0.15_03 commit
[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
41f10371
TC
18=head2 [site]
19
20Contains URL configuration for the site.
21
22=over
23
24=item url
25
26The normal URL for the non-secure parts of the site.
27
28=item secureurl
29
30The secure URL for the shop, products and other portions of the site
31that should use SSL. This isn't checked to make sure it is https.
32
33=item name
34
35Used as the site "name" in a few places.
36
37=item adminurl
38
39If set, this is used as the base URL for accessing the administrative
40functions of your site.
41
42=item secureadmin
43
44Ignored if C<adminurl> is set.
45
46If this is true then C<secureurl> is used as the base URL for
47accessing the administrative functions of your site, otherwise C<url>
48is used as the base URL. Default: false (C<url>'s value is used)
49
50=back
51
61551101
TC
52=head2 [paths]
53
54Contains various file system paths.
55
56=over
57
58=item downloads
59
60This is where the files uploads with the file wizard are stored. It
61must be writable by the web server user.
62
63=item admin_templates
64
65Directory containing administrative templates. Note: this is not
66completely implemented for now, so assume the default. Default: admin
67directory under $TMPLDIR.
68
69=item templates
70
aefcabcb
TC
71Directory base for most templates.
72
73=item local_templates
74
75Local Directory base for templates. This is searched before the
76templates directory.
61551101 77
ca9aa2bf
TC
78=item images
79
80Where uploaded images are stored. This is not yet completely
81implemented. Default: $IMAGEDIR.
82
331fd099
TC
83=item libraries
84
85Local search path for BSE::Custom, or the class configured by
86C<custom_class> in [basic].
87
3c32512d
TC
88=item siteuser_images
89
90Where uploaded siteuser images are stored. This must be set in the
91config file. The default bse.cfg include an entry to use the current
92values of [paths].downloads
93
61551101
TC
94=back
95
96=head2 [extensions]
97
98This section is used by the file wizard to map uploaded file
99extensions to MIME content types. This can be used to extend
100BSE::FileEditor's internal extension map. It cannot override that
101map.
102
103The key for each entry is the extension, without the leading '.'.
104
105eg.
106
107 xls = application/msexcel
108
109=head2 [templates]
110
111Used for translating symbolic template names into full names under the
112template directory.
113
114In each case the default is the name with a C<.tmpl> extension.
115
116=over
117
118=item user/logon
119
120user logon page
121
122=item user/register
123
124user registration page
125
126=back
127
128=head2 [admin templates]
129
130Used for translating the names of administration templates into filenames.
131
132In each case the default is the name with a C<.tmpl> extension.
133
134=over
135
136=item filelist
137
138article file wizard
139
d2730773
TC
140=item catalog
141
142Catalog editor page. Default admin/edit_catalog.tmpl
143
144=item 1
145
146=item 2
147
148=item 3
149
150=item 4
151
152=item 5
153
154Article edit pages. Default admin/edit_<number>.tmpl
155
156=item steps
157
158Step child/parent management page. Default admin/edit_steps.tmpl
159
61551101
TC
160=back
161
162=head2 [html]
163
164Minor html items.
165
166=over
167
168=item charset
169
170The value of the charset keyword when outputting HTML from a script.
171Set to the empty string to suppress the charset keyword. Default:
172iso-8859-1.
173
174=back
175
176=head2 [basic]
177
178=over
179
180=item cookie_lifetime
181
182The expiry time for cookies. This should be in the form supported by
183CGI.pm for the -expires parameter. Typically you want a plus ('+'), a
184number, and a time character (s - seconds, m - minutes, h - hours, d -
185days, M - months). Default: +3h
186
187=item minpassword
188
189Minimum password length in characters. Default: 4.
190
b19047a6
TC
191=item randomdata
192
193Device to read random data from. This device should not block when it
194runs out of entropy.
195
6e3d2da5
TC
196=item sign
197
198If this is true then the encrypted messages containing the customer's
199credit card number are sent to the shop owner signed. To avoid
200keeping a passphrase and signing key on the server you can set this to
201false (0). This has the effect that anyone could send you an unsigned
202message encrypted with your public key, though this may not be a
203security threat. Default: True.
204
ca9aa2bf
TC
205=item link_titles
206
207If this is true then the links to your articles within BSE will be
208followed by a / and then by a simplified version of the article title.
209The aim is to include at least some title information in the URL
210without modifying the name of the HTML file. Default: False.
211
9168c88c
TC
212=item access_control
213
214If this is true then the user/group/permissions database is used to
215control access to the system. Default: False.
216
d49f56a6
TC
217=item server_auth
218
219Set this to non-zero to enable authentication via server
220authentication (usually Basic Authentication.) You should normally
221set this if you set htusers below. Default: 0 (disabled)
222
9168c88c
TC
223=item htusers
224
225This should be the path to a file to be updated with the list of users
226and crypt() versions of their passwords. If this is set then the
227security system will check for a user set by the browser before
228attempting a form based logon. Default: None.
229
331fd099
TC
230=item custom_class
231
232The name of the custom class for your site. This is currently only
233used for article editing customizations. This class should derive
234from BSE::CustomBase. Default: BSE::Custom.
235
b19047a6
TC
236=back
237
238=head2 [mail]
239
35c0719f 240This section controls how BSE sends email.
b19047a6
TC
241
242=over
243
244=item smtp_server
245
246The host or IP address of your mail server. If this is not set
247C<sendmail> will be used instead. If this is set you must also set
248I<helo>.
249
250=item helo
251
252The name that BSE uses to identify itself when sending mail via SMTP.
253Required if I<smtp_server> is set.
254
255=item sendmail
256
257The path to the C<sendmail> binary. Default: /usr/lib/sendmail
258
259=item sendmail_opts
260
261The options supplied to sendmail. Default: -t -oi
262
263You may want to add the -odq option to this if you want mail queued
264rather than sent immediately.
265
61551101
TC
266=back
267
ca9aa2bf 268=head2 [children of I<id>]
721cd24c
TC
269
270Where I<id> is the identifier for an article.
271
272=over
273
274=item template
275
276the name of the default template for children of the given parent
277
278=item template_dirs
279
280a comma-separated list of extra directories under $TMPLDIR to search
281for templates that can be used for children of the given parent article.
282
283=back
284
ca9aa2bf
TC
285=head2 [article I<id>]
286
287Where I<id> is the identifier of an article.
288
289=over
290
291=item template_dirs
292
293A comma-separated list of extra directories under $TMPLDIR to search
294for templates that can be used for children of the given parent
295article.
296
297=item extra_templates
298
299A comma-separated list of extra templates under $TMPLDIR that can be
300used for the given article.
301
302=back
303
caa7299c
TC
304=head2 [level I<level>]
305
306=over
307
308=item template
309
310The default template for this level of article, assuming it hasn't
311been set in the [children of I<article id>] section.
312
313=item template_dirs
314
315A comma-separated list of extra directories under $TMPLDIR to search
316for templates that can be used for articles at the given I<level>.
317
318=back
319
320=head2 [catalogs]
321
322=over
323
324=item template
325
326The default template for catalogs.
327
328=back
329
330=head2 [products]
331
332=over
333
334=item template
335
336The default template for products.
337
d64413ee
TC
338=item extra_templates
339
340A comma separated list of extra templates that can be used for
341products.
342
caa7299c
TC
343=back
344
61551101
TC
345=head2 [messages]
346
347This can be used to control translation of error messages. Each key
348has a prefix identifying the module that uses the error, followed by
349'/' followed by a specific identifier for the message.
350
351Message parameters, expressed as $I<digit>, are replaced with the
352parameters passed to the message. C<$$> is replaced with C<$>.
353
354Each message identifier below is documented with the id, when it
355occurs, the default message, and any parameters.
356
357=over
358
359=item user/needlogon
360
361the user attempted to logon without entering a logon name. Default:
362"Please enter a logon name". No parameters.
363
364=item user/needpass
365
366the user attempted to logon without entering a password. Default:
367"Please enter your password." No parameters.
368
369=item user/baduserpass
370
371the user's logon name or password was not found or did not match.
372Default: "Invalid user or password". No parameters.
373
374=item user/notloggedon
375
376the user attempted to logoff while not logged on. Default: "You
377aren't logged on". No parameters.
378
379=item user/optsoldpass
380
381the user entered a new password on the options page without entering
382their old password. Default: "You need to enter your old password to
383change your password". No parameters.
384
385=back
386
2404a911
TC
387=head2 [downloads]
388
389=over
390
391=item must_be_paid
392
393if non-zero, the order must be marked as paid for before the file can
394be downloaded.
395
396=item must_be_filled
397
398if non-zero the order must be marked as filled before the files can be
399downloaded.
400
4afdbb1b
TC
401=item require_logon
402
403if non-zero the user must be registered/logged on to download I<any>
404file.
405
2404a911
TC
406=back
407
b19047a6
TC
408=head2 [confirmations]
409
410Control over confirmation emails.
411
412=over
413
414=item subject
415
416The subject of email confirmation emails. Default: Subcription
417Confirmation.
418
419=item from
420
421The from field for the email. Default: $SHOP_FROM
422
423=back
424
531fb3bc
TC
425=head2 [subscriptions]
426
427Control over subscription messages.
428
429=over
430
431=item from
432
433The from field for the email. Default: $SHOP_FROM.
434
d09682dd
TC
435=item testname
436
437Default for the "Test Name" field for sending test subscription
438messages.
439
440=item testemail
441
442Default for the "Test Email" field for sending test subscription
443messages.
444
445=item testtextonly
446
447Set to 1 if you want the "Test Text Only" box checked by default for
448sending test subscription messages.
449
450=item testing
451
452Set to 0 to disable display of the test subscription messages portions
453of the subscriptions send form.
454
99b7cef0
TC
455=item text_link_inline
456
457Set to format links as they appear in the text version of emails.
458C<$1> is replaced with the title, C<$2> with the URL and C<$3> with
459the index. C<$$> is replaced with '$'. Default: C<$1 [$3]>
460
461=item text_link_list
462
463Set to format links as they appear at the footer of the body text. If
464this is set to the empty string then no list appears. C<$1>, C<$2>,
465C<$3>, C<$$> are replaced as for I<text_link_inline> and $n is
466replaced with newline. Default: C<[$3] $2>
467
468=item text_link_list_prefix
469
470A line of text produced above the list of URLs if there is one.
471Default: C<----->. $n in this is replaced with newlines.
472
531fb3bc
TC
473=back
474
99b7cef0
TC
475For example, if the configuration is:
476
477 text_link_inline="$1" ($3)
478 text_link_list_prefix=$n$n-------
479 text_link_list=($3) "$1"$n => $2
480
481and the body text is:
482
483 doclink[3]
484 link[http://www.example.com/|Example]
485
486the result will be:
487
488 "The Shop" (1)
489 "Example" (2)
490
491
492 -------
493 (1) "The Shop"
494 => http://www.yoursite.com/shop/index.html
495 (2) "Example"
496 => http://www.example.com/
497
6e3d2da5
TC
498=head2 [search]
499
500=over
501
502=item highlight_partial
503
504If this is true then partial matches will be highlight in search
505result excerpts. Default: True
506
507=back
508
509=head2 [shop]
510
511=over
512
7b81711b
TC
513=item enabled
514
515Used by some templates to check if the shop is enabled. Set this to 1
516to enable the shop, or 0 to disable it.
517
6e3d2da5
TC
518=item register_if_files
519
520If true the customer is required to register before checkout if there
521are any for sale files attached to products in the cart. Default: True
522
523=item require_logon
524
525If true the customer is required to be logged on before checkout,
526whether or not for sale files are attached to products in the cart.
527Default: False.
528
08123550
TC
529=item payment_types
530
531A comma-separated list of acceptable payment types. Default: 0
532
533The possible payment types are:
534
535=over
536
537=item *
538
5390 - the user enters a credit card number, name and expiry date
540
541=item *
542
5431 - the customer will send a cheque
544
545=item *
546
5472 - contact customer for details
548
549=back
550
81f3292d
TC
551Other types can be added by adding entries to the [payment type names]
552and [payment type descs] sections.
553
08123550
TC
554=item address1
555
556=item address2
557
558=item address3
559
560These are used by various shop templates to present an address that a
561cheque payment should be sent to.
562
331fd099
TC
563=item from
564
565From email address for emails sent by the shop. Overides $SHOP_FROM
566in Constants.pm
567
568=item to_name
569
570To name for emailed orders sent by the shop. Overrides $SHOP_TO_NAME
571in Constants.pm
572
573=item to_email
574
575To email for emailed orders sent by the shop. Overrides $SHOP_TO_EMAIL
576in Constants.pm
577
d09682dd
TC
578=item noencrypt
579
580If this is true then orders sent to you by the shop will not be
581encrypted. Enabling this disabled acceptance of credit card orders,
582and the default for C<payment_types> will become C<1> instead or C<0>.
583
584Please realize that other potentially commercially sensitive
585information is being sent in the clear to a central location,
586unencrypted.
587
588=item email_order
589
590If true, then the order is email to to_email, possibly with credit
591card information included. Default: $SHOP_EMAIL_ORDER.
592
d49f56a6
TC
593=item display_I<field>
594
595Used to translate the stored order field name into a presentation name
596suitable for error messages.
597
6e3d2da5
TC
598=back
599
600=head2 [fields]
601
602=over
603
604=item title_size
605
606The maximum length of the article title field. Default: 255. Should
607not be set higher than this unless you change the database schema.
608
609=back
610
ee6577c3
TC
611=head2 [interest]
612
613Controls the interest.pl script.
614
615=over
616
617=item notify
618
619Email address that is notified of the interest. Defaults to $SHOP_FROM.
620
ca9aa2bf 621=back
ee6577c3 622
6e3d2da5
TC
623=head2 [debug]
624
625Used for debugging.
626
627=over
628
629=item logon_cookies
630
631When a user logs on, and the site url is different to the secure url
632BSE attempts to refresh to the other "side" of the site to set the
633same cookie.
634
635BSE does some simple comparisons to attempt to determine whether the
636logon form was triggered on the secure side of the site (possibly from
637the shop) or on the insecure side. Since CGI doesn't necessarily give
638us all the information required, it's possible it will guess wrong.
639
d2730773
TC
640Setting this option to 1 will enable debugging information sent to
641standard error, which will be sent to the error log on Apache. This
642probably isn't useful on IIS.
643
644=item file_unlink
645
646Reports errors to STDERR (hence to the error log on Apache) if there
647is a problem deleting the actual file when an attached file is
648removed.
649
650=item mail_encryption
651
652Reports debugging information to standard error while encrypting your
653mail.
6e3d2da5 654
2d873eb6
TC
655=item cookies
656
657Reports cookies received from the browser and sent to the browser to
658STDERR (hence to the error log on Apache.)
659
4175638b
TC
660=item dump_session
661
662If nonzero the session hash is dumped to STDERR after it is retrived
663from the database.
664
af74f0b4
TC
665=item subscription_expiry
666
667If non-zero then subscription expiry date calculations are dumped to
668STDERR.
669
ca9aa2bf
TC
670=back
671
672=head2 [uri]
673
674Contains various URIs.
675
676This is underused, so don't rely on it yet.
677
678=over
679
680=item cgi
681
682The URI to the CGI directory. Default: /cgi-bin
683
684=item images
685
686The URI where images are kept. Default: /images
687
688=item shop
689
690=item articles
691
9168c88c 692=back
ca9aa2bf 693
9168c88c 694=head2 [articles]
ca9aa2bf 695
9168c88c
TC
696This will provide translations from symbolic names to article ids.
697
698Currently this is used for converting article ids in the access
699control code, and for looking up the id of the shop.
6e3d2da5 700
0b406a07
TC
701=head2 [printable type]
702
703If the user supplies a template name to printable.pl then you can use
704a different content type by adding an entry to this section. The key
705is the template name, and the value is the full content type.
706
918735d1
TC
707=head2 [search index scores]
708
709This section is used when generating the search index to override the
710default scores for each field in the articles.
711
712The default scores are:
713
714 Field Score
715 ----- -----
716 title 5
717 body 3
718 keyword 4
719
720A special key C<file_description> can be used here to set the score
721for indexing downloadable file descriptions, which aren't indexed by
722default. A good value is probably 2 or 1.
723
724=head2 [article flags]
725
726=head2 [product flags]
727
728=head2 [catalog flags]
729
730Flags that can be set for articles, products and catalogs
731respectively. Note that flags for articles are also visible in
732products and catalogs.
733
734All flag Ids are single letters or digits. Uppercase letters are
735reserved for use by BSE internally, leaving lower-case letters and
736digits for your own use.
737
738Use the id of the flag as the key, and a description of the flag as
739it's value.
740
95989433
TC
741=head2 [article uris]
742
743Each key is an article id, the values are base URIs to store the HTML
744form of those articles and their children under.
745
746=head2 [protect link]
747
748The keys are ids of articles that shouldn't have their link field
749overwritten. The value should be a true value, but is otherwise
750ignored.
751
d09682dd
TC
752=head2 [datadump]
753
754=over
755
756=item to
757
758The recipient for the data dump email sent by datadump.pl. Default:
759$DATA_EMAIL.
760
761=item from
762
763the From for the data dump email sent by datadump.pl. Default:
764$SHOP_FROM.
765
766=back
767
2a295ea9
TC
768=head2 [site users]
769
770Configuration for site users.
771
772=over
773
774=item nopassword
775
776If this is set to true then no passwords are required during
777registration, a confirmation email is sent immediately upon
778registration and that confirmation email contains a link the user can
779use to manage their details.
780
781This option has some security concerns since it can leave links to the
782user's information in the browser history. This option is not
783recommended.
784
785You cannot use this to control access to the shop.
786
787=item require_name1
788
789=item require_name2
790
791=item require_address
792
793=item require_city
794
795=item require_state
796
797=item require_postcode
798
799=item require_telephone
800
801=item require_facsimile
802
803=item require_country
804
805=item require_title
806
807=item require_organization
808
809Set these to true to require the corresponding field during
810registration, and to keep it required after modification. Default:
811false.
812
813If you enable any of these, you should enable C<info_on_register> as
814well, or modify the registration template to include the given fields.
815
816=item display_I<field name>
817
818Controls how the given field is displayed in error messages. If you
819change the field names on the registration and/or options forms you
820should probably change them here too. Default: internal field name
821with the first character converted to upper-case.
822
823=item info_on_register
824
825If this is set then the user info is prompted for during user
826registration. The information still isn't required unless the
827appropriate require_I<field> option is set. Default: false.
828
829=item register_refresh
830
831The default URL to refresh to on completing registration if no r
832parameter is supplied.
833
834=item subscribe_all
835
836If this is set then the subcription checkboxes are all checked on
837registration by default. Default: false.
838
839The user will only receive the subscriptions if they leave them checked
840and follow the link in the confirmation email.
841
842=item subscribe_I<id>
843
844Where I<id> is the number identifying a subscription. If this is set
845then the subscription checkbox for that subscription will be checked
846by default on the registration form. Default: false.
847
848The user will only receive the subscriptions if they leave it checked
849and follow the link in the confirmation email.
850
851You can get the I<id> of a subcription by looking at the Edit link on the
852subscriptions management page, the number after "id=" is the id.
853
9063386f
TC
854=item billing_on_main_opts
855
856If set to zero then user billing options will be managed on a separate
857page. This is controlled by the user/options_base.tmpl template.
858
859=item user_register
860
861If set to zero then users cannot register themselves. Default: true,
862allowing users to register themselves.
863
2a295ea9
TC
864=back
865
81f3292d
TC
866=head2 [payment type names]
867
868This section and [payment type descs] are used to configure new
869paymeny type ids.
870
871The key is the integer representing the payment type. The value is
872the name used in tags for checking the payment type.
873
874You can also add a description (currently unused) to [payment type
875descs].
876
877You should use numbers starting from 10 to avoid conflicts with future
878BSE payment types.
879
880=head2 [payment type descs]
881
882See [payment type names].
883
884=head2 [payment type required]
885
886Set the key given by the payment type id to a value of a
887comma-separated list of fields required for that payment type.
888
3ae524f3
TC
889=head2 [help style I<style-name>]
890
891This type of configuration section is used to set values for a style
892of help icon. Only the C<template> and C<prefix> values are used
893directly by the code, the others are used by the default helpicon
894templates.
895
896=over
897
898=item prefix
899
900The URI to the help files for this style. Default: /help/ in style
901"user", /admin/help/ in style "admin".
902
903=item template
904
905The template used to produce the icon. Default: helpicon in style
906user, admin/helpicon in style "admin".
907
908=item icon
909
910URI to the help icon image. Default: /images/admin/help.gif
911
912=item iconwidth
913
914The width of the help icon image. Default: 16
915
916=item iconheight
917
918The height of the help icon image. Default: 16
919
920=back
921
922If you just want to change the help icon image for user help icons you
923might do:
924
925 [help style user]
926 icon=/images/help.gif
927
4175638b
TC
928=head2 [affiliate]
929
930=over
931
932=item allowed_referer
933
934A semi-colon (;) separated list of referer domains that are allowed to
935link to the C<a_set> target of L<affiliate.pl>.
936
937If the user's browser supplies a referer header then it will be
938checked against this list.
939
940=item require_referer
941
942If this is set then the C<a_set> target of L<affiliate.pl> will
943require that the user's browser supply a Referer header.
944
945=item default_refresh
946
947If no C<r> parameter is supplied to the C<a_set> target of
948L<affiliate.pl> then this is used as the default refresh.
949
950Default: the site base url.
951
829c9ed9
TC
952=item subscription_required
953
954This is either the numeric or text of a subscription for which the
955affiliate must have an active subscription.
956
fdc2b7a2
TC
957=item flag_required
958
959A single letter flag which the site administrator must set for the
960affiliate page to be displayed for the given member.
961
4175638b
TC
962=back
963
3c32512d
TC
964=head2 [BSE Siteuser Images]
965
966Each key is the id of a member image, with a corresponding [BSE
967Siteuser Image I<image_id>] section. The values are ignored.
968
969=head2 [BSE Siteuser Image I<image_id>]
970
971Provides information about a single member image "template".
972
973=over
974
975=item description
976
977Short description on the image, like "Logo". Used in error messages.
978
979=item help
980
981Longer description of the image. Accessible with the member_image tag.
982
983=item minwidth
984
985=item minheight
986
987=item maxwidth
988
989=item maxheight
990
991The minimum and maximum dimensions of the image.
992
993=item widthsmallerror
994
995=item heightsmallerror
996
997=item widthlargeerror
998
999=item heightlargeerror
1000
1001Error messages displayed in the when the image is outside the
1002configured dimensions.
1003
1004=item largeerror
1005
1006=item smallerror
1007
1008Default error messages for the above.
1009
1010=item maxspace
1011
1012Maximum storage the image can use in bytes. Default: 1000000.
1013
1014=item spaceerror
1015
1016Error message displayed if the image uses too much storage.
1017
1018=back
1019
ab2cd916
TC
1020=head2 [editor]
1021
1022Various editor settings.
1023
1024=over
1025
1026=item allow_thumb
1027
1028If this is non-zero the system will attempt to load the configured
1029thumbnail class, and put thumbnail images on the image manager page
1030rather than full-size images. Default: off
1031
1032=item thumbs_class
1033
1034The name of a perl class that implement's BSE's thumbnail API. At
1035this point the only class that implements that is BSE::Thumb::Imager,
1036supplied with BSE. Default: None
1037
1038=item default_thumbnail
1039
1040URI to the default thumbnail image. This is presented when the
1041runtime production of a thumbnail image fails.
1042
1043=item default_thumbnail_width
1044
1045=item default_thumbnail_height
1046
1047Dimensions of the default thumbnail image.
1048
1049=item default_thumbnail_alt
1050
1051Alt text for the default thumbnail image.
1052
1053=back
1054
1055=head2 [thumbnails]
1056
1057=over
1058
1059=item max_width
1060
1061=item max_height
1062
1063=item max_pixels
1064
1065Default values for the thumbimage tag.
1066
1067=back
1068
829c9ed9
TC
1069=head2 [includes]
1070
1071Each value is used as the relative or absolute name of a file or
1072directory to load more configuration data from.
1073
1074The keywords must remain unique.
1075
1076Only the [includes] section from bse.cfg itself is used to locate more
1077configuration data.
1078
1079If the value references a directory, all files with an extension of
1080C<.cfg> are read for configuration data.
1081
1082The order the files are read (which later files overriding older
1083files) is:
1084
1085=over
1086
1087=item 1.
1088
1089bse.cfg is read
1090
1091=item 2.
1092
1093the entries in [includes] are sorted alphabetically (or rather
1094asciily), so an entry with key "A" is read before one with key "B",
1095one with key "01" is read before "02", but key "10" would be read
1096I<before> key "2".
1097
1098=item *
1099
1100if an entry is a file then that is read and the values merged.
1101
1102=item *
1103
1104if an entry is a directory, then that is scanned and the files found
1105read alphabetically as above.
1106
1107=back
1108
6a8a6ac5
TC
1109=head2 [error_img]
1110
1111This is used to configure the error icon displayed next to fields that
1112fail validation.
1113
1114=over
1115
1116=item image
1117
1118URI to the image file.
1119
1120=item width
1121
1122=item height
1123
1124The width and height of the error icon image.
1125
1126=back
1127
fdc2b7a2
TC
1128=head2 [site user flags]
1129
1130Flags that can be set for site users.
1131
1132All flag Ids are single letters or digits. Uppercase letters are
1133reserved for use by BSE internally, leaving lower-case letters and
1134digits for your own use.
1135
1136Use the id of the flag as the key, and a description of the flag as
1137it's value.
1138
61551101
TC
1139=head1 AUTHOR
1140
1141Tony Cook <tony@develop-help.com>
1142
1143=cut