git.imager.perl.org - bse.git/blame_incremental

... / ...

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