2
<!-- $Horde: horde/config/conf.xml,v 1.74.2.5 2005/03/22 11:40:14 jan Exp $ -->
4
<configtab name="general" desc="General">
5
<configheader>General Horde Settings</configheader>
6
<configenum name="debug_level" quote="false" desc="The value to set error_reporting()
7
to. See http://www.php.net/manual/function.error-reporting.php for more
10
<value>E_ERROR</value>
11
<value>E_WARNING</value>
12
<value>E_PARSE</value>
13
<value>E_NOTICE</value>
14
<value>E_CORE_ERROR</value>
15
<value>E_CORE_WARNING</value>
19
<configinteger name="max_exec_time" desc="If we need to perform a long
20
operation, what should we set max_execution_time to (in seconds)? 0 means no
21
limit; however, a value of 0 will cause a warning if you are running in safe
22
mode. See http://www.php.net/manual/function.set-time-limit.php for more
23
information.">0</configinteger>
24
<configenum name="use_ssl" quote="false" desc="Determines how we generate
25
full URLs (for location headers and such).<br />NOTE: If you choose to
26
always generate https URLs, you MUST hardcode the correct HTTPS port number
27
in the server port setting below. Otherwise Horde will be unable to generate
28
correct HTTPS URLs when a user tries to access Horde via a non-HTTPS port.">2
30
<value desc="Assume that we are not using SSL and never generate https URLs.">0</value>
31
<value desc="Assume that we are using SSL and always generate https URLs.">1</value>
32
<value desc="Attempt to auto-detect, and generate URLs appropriately">2</value>
33
<value desc="Assume that we are not using SSL and generate https URLs only
37
<configsection name="server">
38
<configphp name="name" desc="What server name should we use? You'll probably
39
know if you need to change this default; only in situations where you need to
40
override what Apache thinks the server name
41
is.">$_SERVER['SERVER_NAME']</configphp>
42
<configphp name="port" desc="What port number is the webserver running on?
43
Again, you shouldn't need to change the default, and you probably know it if
44
you do. The exception is if you have chosen to always generate https URLs, as
45
described above.">$_SERVER['SERVER_PORT']</configphp>
47
<configboolean name="compress_pages" desc="If this option is set to true, and
48
you have the php zlib extension, pages over a certain size will be compressed
49
and sent to the browser as gzip-encoded data in order to save
50
bandwidth. There is a CPU-usage penalty to pay for this, but the decrease in
51
page size can be dramatic (70k to under 10k for a full mailbox page), and is
52
more than worth it over anything but an extremely fast
53
link.">true</configboolean>
54
<configinteger name="umask" octal="true" desc="What umask should we run with? This will affect the permissions on any temporary files that are created. This value is an integer.">077</configinteger>
55
<configstring name="tmpdir" required="false" desc="If you want to use a
56
temporary directory other than the system default or the one specified in
57
php's upload_tmp_dir value, enter it here."/>
58
<configsection name="session">
59
<configstring name="name" desc="What name should we use for the session that
60
Horde apps share? If you want to share sessions with other applications on
61
your webserver, you will need to make sure that they are using the same
62
session name. Note: Session names must consist of only alphanumeric
63
characters.">Horde</configstring>
64
<configstring name="cache_limiter" desc="What caching level should we use
65
for the session? DO NOT CHANGE THIS UNLESS YOU <b>REALLY</b> KNOW
66
WHAT YOU ARE DOING. Setting this to anything other than 'nocache' will almost
67
certainly result in severely broken script behavior.">nocache</configstring>
68
<configphp name="timeout" desc="How long should sessions last? 0 means
69
that the session ends when the user closes their browser. Set other values
71
http://www.php.net/manual/en/function.session-set-cookie-params.php.">0</configphp>
73
<configsection name="cookie">
74
<configphp name="domain" desc="What domain should we set cookies from? If
75
you have a cluster that needs to share cookies, this might be '.example.com'
76
- the leading '.' is important. Most likely, though, you won't have to change
77
the default.">$_SERVER['SERVER_NAME']</configphp>
78
<configstring name="path" desc="What path should we set cookies to? This
79
should match where Horde is on your webserver - if it is at /horde, then this
80
should be '/horde'. If Horde is installed as the document root, then this
81
needs to be '/' - NOT ''.<br /><b>BUT</b>, if IE will be
82
used to access Horde modules, you should read this first (discussing issues
83
with IE's Content Advisor):
84
http://lists.horde.org/archives/imp/Week-of-Mon-20030113/029149.html">/horde</configstring>
88
<configtab name="sql" desc="Database">
89
<configsection name="sql">
90
<configheader>Horde Database Settings</configheader>
91
<configsql switchname="phptype" baseconfig="true" />
95
<configtab name="auth" desc="Authentication">
96
<configsection name="auth">
97
<configheader>Horde Authentication</configheader>
98
<configlist name="admins" desc="Which users should be treated as
99
administrators (root, super-user) by Horde?"/>
100
<configboolean name="checkip" desc="Should we always store and validate
101
the IP address of the client (as seen by the web server) in the session?
102
Doing so will help increase security by ensuring that an attacker from
103
another host can not try to hijack the session.">true</configboolean>
104
<configswitch name="driver" desc="What backend should we use for
105
authenticating users to Horde?">
107
<case name="application" desc="Let a Horde application handle
109
<configsection name="params">
110
<configenum name="app" desc="The application which is providing
113
<configspecial name="list-horde-apps"/>
119
<case name="auto" desc="Automatic authentication as a certain user">
120
<configsection name="params">
121
<configstring name="username" desc="The username to authenticate everyone as">horde_user</configstring>
122
<configstring name="password" desc="The password to use for the user's credentials" required="false"/>
123
<configboolean name="requestuser" desc="Allow username to be passed by GET, POST or cookie?">false</configboolean>
127
<case name="composite" desc="Composite authentication">
129
This authentication driver needs manual configuration not possible
130
through this interface. Add the appropriate configuration lines at the
131
end of the generated configuration file.
135
<case name="ftp" desc="FTP authentication">
136
<configsection name="params">
137
<configstring name="hostspec" desc="The hostname or IP address of the FTP
138
server">localhost</configstring>
139
<configinteger name="port" desc="The server port to connect
140
to">21</configinteger>
144
<case name="http" desc="HTTP (Basic Authentication/.htpasswd)
146
<configsection name="params">
147
<configstring name="htpasswd_file" required="false" desc="The location of
148
the htpasswd file containing the user names and passwords"/>
149
<configenum name="encryption" desc="Specifies what kind of passwords are
150
in the htpasswd file">des
152
<value>aprmd5</value>
154
<value>crypt-blowfish</value>
155
<value>crypt-des</value>
156
<value>crypt-md5</value>
157
<value>md5-base64</value>
158
<value>md5-hex</value>
168
<case name="imap" desc="IMAP authentication">
169
<configsection name="params">
170
<configswitch name="imapconfig" desc="Configuration type">
171
<case name="dsn" desc="DSN">
172
<configstring name="dsn" desc="The full IMAP connection
173
string">{localhost:143/imap/notls}</configstring>
175
<case name="separate" desc="Separate values">
176
<configstring name="hostspec" desc="The hostname or IP address of the
177
server">localhost</configstring>
178
<configinteger name="port" desc="The server port to which we will
179
connect. IMAP is generally 143, while IMAP-SSL is generally
180
993.">143</configinteger>
181
<configenum name="protocol" desc="The connection protocol">imap
184
<value>imap/notls</value>
185
<value>imap/ssl</value>
186
<value>imap/ssl/novalidate-cert</value>
194
<case name="imsp" desc="IMSP server authentication">
195
<configsection name="params">
196
<configstring name="server" required="true" desc="Hostname of IMSP server">localhost</configstring>
197
<configstring name="port" required="true" desc="The port number the IMSP server runs on">406</configstring>
198
<configenum name="auth_method" desc="The authentication method to use">plaintext
200
<value desc="Plaintext">plaintext</value>
201
<value desc="CRAM-MD5">cram_md5</value>
207
<case name="ipbasic" desc="Simple IP based authentication">
208
<configsection name="params">
209
<configlist name="blocks" desc="A list of CIDR masks which are allowed
214
<case name="ipmap" desc="IP based authentication">
215
<configsection name="params">
216
<configlist name="blocks" desc="A list of CIDR masks which are allowed
221
<case name="krb5" desc="Kerberos authentication"/>
223
<case name="kolab" desc="Kolab authentication" />
225
<case name="ldap" desc="LDAP authentication">
226
<configsection name="params">
227
<configstring name="hostspec" desc="The hostname of the LDAP server">localhost</configstring>
228
<configstring name="basedn" desc="The base DN for the LDAP server"/>
229
<configstring name="binddn" required="false" desc="The DN used to bind to the LDAP server"/>
230
<configstring name="password" required="false" desc="The password used to bind to the LDAP server"/>
231
<configenum name="version" desc="LDAP Protocol Version">2
233
<value desc="LDAPv2 (Deprecated)">2</value>
234
<value desc="LDAPv3">3</value>
237
<configstring name="uid" desc="The username search key"/>
238
<configswitch name="filter_type" desc="How to specify a filter for the user lists">objectclass
239
<case name="objectclass" desc="One or more objectclass filters">
240
<configlist name="objectclass" desc="The objectclass filter used to search for users. Can be a single objectclass or a list."/>
242
<case name="free" desc="A complete LDAP filter expression">
243
<configstring name="filter" desc="The LDAP RFC formatted filter used to search for users."/>
249
<case name="login" desc="Login (su) authentication">
250
<configsection name="params">
251
<configstring name="location" desc="Location of the su binary">/bin/su</configstring>
255
<case name="mcal" desc="MCAL authentication">
256
<configsection name="params">
257
<configstring name="calendar" desc="The MCAL calendar name"/>
261
<case name="pam" desc="PAM (Pluggable Authentication Modules) authentication">
262
<configsection name="params">
263
<configstring name="service" desc="The name of the PAM service to use when authenticating">php</configstring>
267
<case name="passwd" desc="passwd file authentication">
268
<configsection name="params">
269
<configstring name="filename" desc="The passwd file to use">/etc/passwd</configstring>
270
<configboolean name="lock" desc="Should we lock the passwd file?">false</configboolean>
274
<case name="radius" desc="Radius authentication">
275
<configsection name="params">
276
<configstring name="host" desc="The RADIUS host to use (IP address or fully qualified hostname)">localhost</configstring>
277
<configinteger name="port" required="false" desc="The port to use on the RADIUS server"/>
278
<configenum name="method" desc="The RADIUS method to use for validating the request">PAP
280
<value desc="PAP">PAP</value>
281
<value desc="CHAP_MD5 (not supported at the moment)">CHAP_MD5</value>
282
<value desc="MSCHAPv1 (not supported at the moment)">MSCHAPv1</value>
283
<value desc="MSCHAPv2 (not supported at the moment)">MSCHAPv2</value>
286
<configstring name="nas" required="false" desc="The RADIUS NAS identifier to use." />
287
<configstring name="secret" desc="The RADIUS shared secret string for the
288
host. The RADIUS protocol ignores all but the leading 128 bytes of the
290
<configinteger name="retries" required="false" desc="The maximum number
291
of repeated requests to make before giving up [3]"/>
292
<configstring name="suffix" required="false" desc="The domain name to add
293
to unqualified user names"/>
294
<configinteger name="timeout" required="false" desc="The timeout for
295
receiving replies from the server (in seconds) [3]"/>
299
<case name="sasl" desc="SASL authentication">
300
<configsection name="params">
301
<configstring name="app" desc="The name of the authenticating
302
application">horde</configstring>
303
<configstring name="service" desc="The name of the SASL service to use
304
when authenticating">php</configstring>
308
<case name="smb" desc="SMB authentication">
309
<configsection name="params">
310
<configstring name="hostspec" desc="IP, DNS Name, or NetBios Name of the
311
SMB server to authenticate with">localhost</configstring>
312
<configstring name="domain" desc="The domain name to authenticate with"/>
313
<configstring name="group" required="false" desc="Optional group name
314
that the user must be a member of"/>
318
<case name="sql" desc="SQL authentication">
319
<configsection name="params">
320
<configswitch name="driverconfig" desc="Driver configuration">horde
321
<case name="horde" desc="Horde defaults"/>
322
<case name="custom" desc="Custom parameters">
323
<configenum name="phptype" desc="The name of the database">mysql
325
<value desc="Microsoft SQL Server">mssql</value>
326
<value desc="MySQL">mysql</value>
327
<value desc="ODBC">odbc</value>
328
<value desc="Oracle 8">oci8</value>
329
<value desc="PostgreSQL">pgsql</value>
332
<configswitch name="protocol" desc="What protocol will we use to
333
connect to the database?">unix
334
<case name="unix" desc="UNIX Sockets">
335
<configstring name="socket" required="false" desc="Location of UNIX
336
socket"></configstring>
338
<case name="tcp" desc="TCP/IP">
339
<configinteger name="port" required="false" desc="Port the DB is
340
running on, if non-standard">5432</configinteger>
343
<configstring name="hostspec" desc="What hostname is the database
344
server running on, or what is the name of the system DSN to
345
use?">localhost</configstring>
346
<configstring name="username" desc="What username do we authenticate to
347
the database server as?">horde</configstring>
348
<configstring name="password" required="false" desc="What password do
349
we authenticate to the database server with?"/>
350
<configstring name="database" desc="What database name/tablespace are we
351
using?">horde</configstring>
354
<configstring name="table" required="false" desc="The name of the auth
355
table in the database [horde_users]"/>
356
<configstring name="username_field" required="false" desc="The name of the
357
username field in the auth table [user_uid]"/>
358
<configstring name="password_field" required="false" desc="The name of the
359
password field in the auth table [user_pass]"/>
360
<configenum name="encryption" required="false" desc="The encryption to use
361
to store the password in the table">md5-hex
364
<value>crypt-blowfish</value>
365
<value>crypt-des</value>
366
<value>crypt-md5</value>
367
<value>md5-base64</value>
368
<value>md5-hex</value>
375
<configboolean name="show_encryption" required="false" desc="Prepend the
376
encryption in the password field?">false</configboolean>
380
<case name="customsql" desc="SQL authentication w/custom-made queries">
381
<configsection name="params">
382
<configenum name="phptype" desc="The name of the database">mysql
384
<value desc="Microsoft SQL Server">mssql</value>
385
<value desc="MySQL">mysql</value>
386
<value desc="ODBC">odbc</value>
387
<value desc="Oracle 8">oci8</value>
388
<value desc="PostgreSQL">pgsql</value>
391
<configswitch name="protocol" desc="What protocol will we use to connect to the database?">unix
392
<case name="unix" desc="UNIX Sockets">
393
<configstring name="socket" required="false" desc="Location of UNIX socket"></configstring>
395
<case name="tcp" desc="TCP/IP">
396
<configinteger name="port" required="false" desc="Port the DB is running on, if non-standard">5432</configinteger>
399
<configstring name="hostspec" desc="What hostname is the database server running on, or what is the name of the system DSN to use?">localhost</configstring>
400
<configstring name="username" desc="What username do we authenticate to the database server as?">horde</configstring>
401
<configstring name="password" required="false" desc="What password do we authenticate to the database server with?"/>
402
<configstring name="database" desc="What database name/tablespace are we using?">horde</configstring>
404
Some special tokens can be used in the sql query. They are replaced at
405
the query stage:<ul>
406
<li>"\L" will be replaced by the user's login</li>
407
<li>"\P" will be replaced by the user's password</li>
408
<li>"\O" will be replaced by the old user's login (required for
409
update)</li></ul>
410
Eg: "SELECT * FROM users WHERE uid = \L AND passwd = \P AND billing =
413
<configstring name="query_auth" desc="Authenticate the user"/>
414
<configstring name="query_add" desc="Add user"/>
415
<configstring name="query_update" desc="Update user"/>
416
<configstring name="query_remove" desc="Remove user"/>
417
<configstring name="query_list" desc="List users"/>
418
<configenum name="encryption" desc="The encryption to use to store the
419
password in the table">md5-hex
421
<value>aprmd5</value>
423
<value>crypt-blowfish</value>
424
<value>crypt-des</value>
425
<value>crypt-md5</value>
426
<value>md5-base64</value>
427
<value>md5-hex</value>
434
<configboolean name="show_encryption" desc="Prepend the encryption in the
435
password field?">false</configboolean>
439
<case name="cyrsql" desc="SQL implementation for the Cyrus IMAP server">
440
<configsection name="params">
441
<configstring name="cyradmin" desc="The username of the cyrus
443
<configstring name="cyrpass" desc="The password for the cyrus
445
<configstring name="imap_dsn" desc="The full IMAP DSN
446
(i.e. {localhost:993/imap/ssl/novalidate-cert})"/>
447
<configenum name="phptype" desc="The name of the database">mysql
449
<value desc="Microsoft SQL Server">mssql</value>
450
<value desc="MySQL">mysql</value>
451
<value desc="ODBC">odbc</value>
452
<value desc="Oracle 8">oci8</value>
453
<value desc="PostgreSQL">pgsql</value>
456
<configswitch name="protocol" desc="What protocol will we use to connect to the database?">unix
457
<case name="unix" desc="UNIX Sockets">
458
<configstring name="socket" required="false" desc="Location of UNIX socket"></configstring>
460
<case name="tcp" desc="TCP/IP">
461
<configinteger name="port" required="false" desc="Port the DB is running on, if non-standard">5432</configinteger>
464
<configstring name="hostspec" desc="What hostname is the database server running on, or what is the name of the system DSN to use?">localhost</configstring>
465
<configstring name="username" desc="What username do we authenticate to the database server as?">horde</configstring>
466
<configstring name="password" required="false" desc="What password do we authenticate to the database server with?"/>
467
<configstring name="database" desc="What database name/tablespace are we
468
using?">horde</configstring>
469
<configstring name="table" desc="The name of the auth table in the
470
database">horde_users</configstring>
471
<configstring name="username_field" desc="The name of the username field
472
in the auth table">user_uid</configstring>
473
<configstring name="password_field" desc="The name of the password field
474
in the auth table">user_pass</configstring>
475
<configstring name="domain_field" desc="If set to anything other than
476
'none' this is used as field name where domain is
477
stored">none</configstring>
478
<configenum name="encryption" desc="The encryption to use to store the
479
password in the table">md5-hex
481
<value>aprmd5</value>
483
<value>crypt-blowfish</value>
484
<value>crypt-des</value>
485
<value>crypt-md5</value>
486
<value>md5-base64</value>
487
<value>md5-hex</value>
494
<configlist name="folders" desc="A list of folders to create under
496
<configinteger name="quota" required="false" desc="The quota (in
497
kilobytes) to grant on the mailbox"/>
498
<configboolean name="unixhier" desc="The value of imapd.conf's
499
unixhierarchysep setting. Check this if the value is true in
500
imapd.conf.">false</configboolean>
504
<case name="yahoo" desc="Yahoo! authentication"/>
509
<configtab name="signup" desc="Sign Up">
510
<configsection name="signup">
511
<configheader>Horde Sign Up</configheader>
512
<configboolean name="allow" desc="Allow non-registered users to register and
513
provide a link on the login screen?">false</configboolean>
514
<configboolean name="approve" desc="Admin has to approve any user submitted
515
registration requests? (WARNING: Setting to false would mean that every user
516
who signs up would have automatic access to your horde system.)">true</configboolean>
517
<configboolean name="preprocess" desc="Pass the user submitted information
518
through the _horde_hook_signup_preprocess function in hooks.php before
519
processing the request?">false</configboolean>
520
<configboolean name="queue" desc="Pass the user submitted information
521
through the _horde_hook_signup_queue function in hooks.php after processing
522
the request but before actually queueing it?">false</configboolean>
526
<configtab name="log" desc="Logging">
527
<configsection name="log">
528
<configheader>Horde Logging</configheader>
529
<configswitch name="enabled" quote="false" desc="Should Horde log errors and other useful
531
<case name="true" desc="Yes">
532
<configenum name="priority" quote="false" desc="What level of messages
533
should we log? Each level logs itself and all those that come before it:
534
PEAR_LOG_ALERT would only log alerts and emergencies, but PEAR_LOG_DEBUG
535
would log everything.">PEAR_LOG_NOTICE
537
<value desc="PEAR_LOG_EMERG">PEAR_LOG_EMERG</value>
538
<value desc="PEAR_LOG_ALERT">PEAR_LOG_ALERT</value>
539
<value desc="PEAR_LOG_CRIT">PEAR_LOG_CRIT</value>
540
<value desc="PEAR_LOG_ERR">PEAR_LOG_ERR</value>
541
<value desc="PEAR_LOG_WARNING">PEAR_LOG_WARNING</value>
542
<value desc="PEAR_LOG_NOTICE">PEAR_LOG_NOTICE</value>
543
<value desc="PEAR_LOG_INFO">PEAR_LOG_INFO</value>
544
<value desc="PEAR_LOG_DEBUG">PEAR_LOG_DEBUG</value>
547
<configstring name="ident" desc="What identifier should we use in the
548
logs?">HORDE</configstring>
550
<configsection name="params">
554
<configswitch name="type" desc="What log driver should we use?">file
555
<case name="console" desc="Console">
556
<configsection name="params">
557
<configphp name="stream" required="false" desc="The output stream to
559
<configboolean name="buffering" required="false" desc="Should the
560
output be buffered until shutdown?">false</configboolean>
561
<configstring name="lineFormat" required="false" desc="Log line format
563
<configstring name="timeFormat" required="false" desc="Time stamp
568
<case name="display" desc="Display">
569
<configsection name="params">
570
<configstring name="error_prepend" required="false" desc="This string
571
will be prepended to the log output"/>
572
<configstring name="error_append" required="false" desc="This string
573
will be appended to the log output"/>
577
<case name="error_log" desc="Error Log">
578
<configsection name="params">
579
<configstring name="destination" required="false" desc="Optional
580
destination value for error_log(). See
581
http://www.indelible.org/pear/Log/guide.html#error-log-types for more
583
<configstring name="extra_headers" required="false" desc="Additional
584
headers to pass to the mail() function when the PEAR_LOG_TYPE_MAIL type
589
<case name="file" desc="File">
590
<configstring name="name" desc="Path to the log
591
file">/tmp/horde.log</configstring>
592
<configsection name="params">
593
<configboolean name="append" required="false" desc="Should new log
594
entries be appended to an existing log file? If this is false, new log files
595
will overwrite existing ones.">true</configboolean>
596
<configinteger name="mode" octal="true" required="false" desc="Octal
597
representation of the log file's permissions mode"/>
598
<configphp name="eol" required="false" desc="The end-of-line character
600
<configstring name="lineFormat" required="false" desc="Log line format
602
<configstring name="timeFormat" required="false" desc="Time stamp
607
<case name="mail" desc="Mail">
608
<configstring name="name" desc="The recipient for the message"/>
609
<configsection name="params">
610
<configstring name="from" required="false" desc="Value for the
611
message's From: header"/>
612
<configstring name="subject" required="false" desc="Value for the
613
message's Subject: header"/>
614
<configstring name="preamble" required="false" desc="Preamble for the
619
<case name="mcal" desc="Mcal">
620
<configsection name="params">
621
<configstring name="calendar" desc="The MCAL calendar name"/>
622
<configstring name="username" desc="Connect to MCAL as"/>
623
<configstring name="password" desc="Password to connect with"/>
627
<case name="null" desc="Null"/>
629
<case name="sql" desc="SQL">
630
<configstring name="name" desc="The table to log
631
to">log_table</configstring>
632
<configsection name="params">
633
<configphp name="dsn" desc="A Data Source
634
Name">$conf['sql']</configphp>
638
<case name="sqlite" desc="SQLite">
639
<configstring name="name" desc="The table to log
640
to">log_table</configstring>
641
<configsection name="params">
642
<configstring name="filename" desc="Path to an Sqlite database"/>
643
<configinteger name="mode" octal="true" required="false" desc="Octal
644
mode used to open the database [0666]"/>
645
<configboolean name="persistent" required="false" desc="Use a
646
persistent connection">false</configboolean>
650
<case name="syslog" desc="Syslog">
651
<configphp name="name" quote="false" desc="Syslog facility to use"/>
654
<case name="win" desc="Window">
655
<configstring name="name" desc="Name of the opened window"/>
656
<configsection name="params">
657
<configstring name="title" required="false" desc="The title of the
664
<case name="false" desc="No"/>
667
<configboolean name="log_accesskeys" desc="Should Horde log statistics about
668
used access keys? This is only useful for translators of the
669
UI. You also need to set the log level to at least
670
PEAR_LOG_INFO.">false</configboolean>
673
<configtab name="prefs" desc="Preference System">
674
<configsection name="prefs">
675
<configheader>Preference System Settings</configheader>
676
<configinteger name="maxsize" required="false" desc="The size of the
677
preferences field in your backend in bytes. Horde will reject any write to
678
the preferences backend if its length exceeds this value. Leave empty to
679
skip this checking. E.g. MySQL stores the preference data in a LONGTEXT
680
field. This field can hold 4294967295 bytes so most likely checking is not
681
needed. However other DB installations may only have a storage size of 64
682
KB (65535 bytes). These installations would want to turn checking on."/>
683
<configswitch name="driver" desc="What preferences driver should we use?">none
684
<case name="none" desc="None"/>
685
<case name="imsp" desc="IMSP Server">
686
<configsection name="params">
687
<configstring name="server" desc="The hostname of the IMSP server">localhost</configstring>
688
<configstring name="port" desc="The port number of the IMSP server">406</configstring>
689
<configenum name="auth_method" desc="What authentication method do you want to use?">plaintext
691
<value desc="Plaintext">plaintext</value>
692
<value desc="CRAM-MD5">cram_md5</value>
697
<case name="sql" desc="SQL Database">
698
<configsection name="params">
699
<configswitch name="driverconfig" desc="Driver configuration">horde
700
<case name="horde" desc="Horde defaults">
701
<configstring name="table" required="false" desc="The name of the
702
preference table in the database [horde_prefs]"/>
704
<case name="custom" desc="Custom parameters">
705
<configenum name="phptype" desc="What database backend should we use?">mysql
707
<value desc="Microsoft SQL Server">mssql</value>
708
<value desc="MySQL">mysql</value>
709
<value desc="ODBC">odbc</value>
710
<value desc="Oracle 8">oci8</value>
711
<value desc="PostgreSQL">pgsql</value>
714
<configboolean name="persistent" desc="Request persistent connections?">false</configboolean>
715
<configswitch name="protocol" desc="What protocol will we use to connect to the database?">unix
716
<case name="unix" desc="UNIX Sockets">
717
<configstring name="socket" required="false" desc="Location of UNIX socket"></configstring>
719
<case name="tcp" desc="TCP/IP">
720
<configinteger name="port" required="false" desc="Port the DB is running on, if non-standard">5432</configinteger>
723
<configstring name="hostspec" desc="What hostname is the database server running on, or what is the name of the system DSN to use?">localhost</configstring>
724
<configstring name="username" desc="What username do we authenticate to the database server as?">horde</configstring>
725
<configstring name="password" required="false" desc="What password do we authenticate to the database server with?"/>
726
<configstring name="database" desc="What database name/tablespace are we using?">horde</configstring>
727
<configstring name="table" required="false" desc="The name of the preference table in the database">horde_prefs</configstring>
728
<configstring name="charset" desc="What charset does the database use internally?">iso-8859-1</configstring>
733
<case name="ldap" desc="LDAP">
734
<configsection name="params">
735
<configstring name="hostspec" desc="The hostname of the LDAP server">localhost</configstring>
736
<configinteger name="port" desc="The port of the LDAP server">389</configinteger>
737
<configenum name="version" desc="LDAP Protocol Version">2
739
<value desc="LDAPv2 (Deprecated)">2</value>
740
<value desc="LDAPv3">3</value>
743
<configstring name="basedn" desc="The base DN for the LDAP server"/>
744
<configstring name="rootdn" required="false" desc="The DN of the root (administrative) account to bind for write operations"/>
745
<configstring name="password" required="false" desc="The password of the root DN for bind authentication"/>
746
<configstring name="uid" desc="The username search key"/>
749
<case name="session" desc="PHP Sessions"/>
750
<case name="kolab" desc="Kolab (LDAP)" />
755
<configtab name="datatree" desc="DataTree System">
756
<configsection name="datatree">
757
<configheader>DataTree System Settings</configheader>
758
<configswitch name="driver" desc="What backend should we use for Horde
759
DataTree storage?">null
760
<case name="null" desc="None"/>
761
<case name="sql" desc="SQL Database">
762
<configsection name="params">
763
<configswitch name="driverconfig" desc="Driver configuration">horde
764
<case name="horde" desc="Horde defaults">
765
<configstring name="table" required="false" desc="The name of the
766
data table in the database [horde_datatree]"/>
768
<case name="custom" desc="Custom parameters">
769
<configenum name="phptype" desc="What database backend should we use?">mysql
771
<value desc="Microsoft SQL Server">mssql</value>
772
<value desc="MySQL">mysql</value>
773
<value desc="ODBC">odbc</value>
774
<value desc="Oracle 8">oci8</value>
775
<value desc="PostgreSQL">pgsql</value>
778
<configboolean name="persistent" desc="Request persistent connections?">false</configboolean>
779
<configswitch name="protocol" desc="What protocol will we use to connect to the database?">unix
780
<case name="unix" desc="UNIX Sockets">
781
<configstring name="socket" required="false" desc="Location of UNIX socket"></configstring>
783
<case name="tcp" desc="TCP/IP">
784
<configinteger name="port" required="false" desc="Port the DB is running on, if non-standard">5432</configinteger>
787
<configstring name="hostspec" desc="What hostname is the database server running on, or what is the name of the system DSN to use?">localhost</configstring>
788
<configstring name="username" desc="What username do we authenticate to the database server as?">horde</configstring>
789
<configstring name="password" required="false" desc="What password do we authenticate to the database server with?"/>
790
<configstring name="database" desc="What database name/tablespace are we using?">horde</configstring>
791
<configstring name="table" required="false" desc="The name of the
792
data table in the database [horde_datatree]"/>
793
<configstring name="charset" desc="What charset does the database use internally?">iso-8859-1</configstring>
802
<configtab name="group" desc="Groups">
803
<configsection name="group">
804
<configheader>Groups Settings</configheader>
806
The Hooks backend extends the DataTree backend to allow hooks to extend a
807
group to dynamically include members into a group. See hooks.php.dist for
810
<configenum name="driver" desc="What backend should we use for Horde
813
<value desc="DataTree">datatree</value>
814
<value desc="Hooks">hooks</value>
820
<configtab name="cache" desc="Cache System">
821
<configsection name="cache">
822
<configheader>Cache System Settings</configheader>
823
<configinteger name="default_lifetime" desc="How long, in seconds, should objects be
824
cached by default?">1800</configinteger>
825
<configswitch name="driver" desc="If you want to enable the Horde Cache,
826
select a driver here. This is used to speed up portions of Horde by storing
827
commonly processed objects to disk.">file
828
<case name="none" desc="Don't cache any objects"/>
829
<case name="file" desc="Store objects in filesystem">
830
<configsection name="params">
831
<configphp name="dir" required="false" desc="The location to store the
832
cached files">Horde::getTempDir()</configphp>
833
<configstring name="prefix" required="false" desc="The filename prefix to
834
use for the cache files."/>
837
<case name="zps4" desc="Use the Zend Performance Suite output cache"/>
842
<configtab name="token" desc="Token System">
843
<configsection name="token">
844
<configheader>Token System Settings</configheader>
845
<configinteger name="timeout" required="false" desc="The period (in
846
seconds) after which an id is purged"/>
847
<configswitch name="driver" desc="If you want to enable Form Tokens, select
848
a driver here. This is used by the Horde::Form:: API and some other parts
849
of Horde to ensure that a form can only be submitted once.">none
850
<case name="none" desc="Disable Form Tokens"/>
851
<case name="file" desc="Local filesystem token storage">
852
<configstring name="token_dir" required="false" desc="The directory where
853
to keep token files"/>
855
<case name="sql" desc="SQL-based token storage">
856
<configsection name="params">
857
<configswitch name="driverconfig" desc="Driver configuration">horde
858
<case name="horde" desc="Horde defaults">
859
<configstring name="table" required="false" desc="The name of the
860
tokens table in the database [horde_tokens]"/>
862
<case name="custom" desc="Custom parameters">
863
<configenum name="phptype" desc="What database backend should we use?">mysql
865
<value desc="Microsoft SQL Server">mssql</value>
866
<value desc="MySQL">mysql</value>
867
<value desc="ODBC">odbc</value>
868
<value desc="Oracle 8">oci8</value>
869
<value desc="PostgreSQL">pgsql</value>
872
<configboolean name="persistent" desc="Request persistent connections?">false</configboolean>
873
<configswitch name="protocol" desc="What protocol will we use to connect to the database?">unix
874
<case name="unix" desc="UNIX Sockets">
875
<configstring name="socket" required="false" desc="Location of UNIX socket"></configstring>
877
<case name="tcp" desc="TCP/IP">
878
<configinteger name="port" required="false" desc="Port the DB is running on, if non-standard">5432</configinteger>
881
<configstring name="hostspec" desc="What hostname is the database server running on, or what is the name of the system DSN to use?">localhost</configstring>
882
<configstring name="username" desc="What username do we authenticate to the database server as?">horde</configstring>
883
<configstring name="password" required="false" desc="What password do we authenticate to the database server with?"/>
884
<configstring name="database" desc="What database name/tablespace are we using?">horde</configstring>
885
<configstring name="table" required="false" desc="The name of the
886
tokens table in the database [horde_tokens]"/>
887
<configstring name="charset" desc="What charset does the database use internally?">iso-8859-1</configstring>
896
<configtab name="mailer" desc="Mailer">
897
<configsection name="mailer">
898
<configheader>Mailer</configheader>
899
<configswitch name="type" desc="What method should we use for sending
901
<case name="null" desc="Disable mailing" />
902
<case name="sendmail" desc="Use the local sendmail binary">
903
<configsection name="params">
904
<configstring name="sendmail_path" required="false" desc="The location
905
of the sendmail binary on the filesystem
906
[/usr/sbin/sendmail]">/usr/lib/sendmail</configstring>
907
<configstring name="sendmail_args" required="false" desc="Any extra
908
parameters to pass to the sendmail or sendmail wrapper
909
binary">-oi</configstring>
912
<case name="smtp" desc="Use a SMTP server">
913
<configsection name="params">
914
<configstring name="host" required="false" desc="The server to connect
916
<configinteger name="port" required="false" desc="The port to connect
918
<configstring name="localhost" required="false" desc="The local hostname
919
/ domain [localhost]"/>
920
<configenum name="auth" desc="SMTP authentication">0
922
<value desc="No authentication">0</value>
923
<value desc="Best available authentication">1</value>
924
<value>DIGEST-MD5</value>
925
<value>CRAM-MD5</value>
930
<configstring name="username" required="false" desc="The username to use for SMTP auth"/>
931
<configstring name="password" required="false" desc="The password to use for SMTP auth"/>
938
<configtab name="vfs" desc="Virtual File Storage">
939
<configsection name="vfs">
940
<configheader>Virtual File Storage</configheader>
941
<configswitch name="type" desc="If a VFS (virtual filesystem) backend is
942
required, which one should we use?">file
943
<case name="file" desc="Files on the local system">
944
<configsection name="params">
945
<configstring name="vfsroot" desc="Where on the real filesystem should
946
Horde use as root of the virtual filesystem?">/tmp</configstring>
949
<case name="sql" desc="SQL database">
950
<configsection name="params">
951
<configsql switchname="driverconfig">
952
<configstring name="vfs_table" desc="The name of the VFS table in the
953
database [horde_vfs]" required="false"/>
961
<configtab name="session" desc="Custom Session Handler">
962
<configsection name="sessionhandler">
963
<configheader>Custom Session Handler</configheader>
964
<configswitch name="type" desc="What sessionhandler driver should we
966
<case name="none" desc="Use the default PHP (file-based) session handler"/>
967
<case name="external" desc="Use your own custom session handler">
968
<configsection name="params">
969
<configstring name="open" desc="Your open() function"/>
970
<configstring name="close" desc="Your close() function"/>
971
<configstring name="read" desc="Your read() function"/>
972
<configstring name="write" desc="Your write() function"/>
973
<configstring name="destroy" desc="Your destroy() function"/>
974
<configstring name="gc" desc="Your gc() function"/>
977
<case name="dbm" desc="DBM based sessions"/>
978
<case name="mysql" desc="MySQL based sessions">
979
<configsection name="params">
980
<configboolean name="persistent" desc="Request persistent connections?">false</configboolean>
981
<configswitch name="protocol" desc="What protocol will we use to connect to the database?">unix
982
<case name="unix" desc="UNIX Sockets">
983
<configstring name="socket" required="false" desc="Location of UNIX socket"></configstring>
985
<case name="tcp" desc="TCP/IP">
986
<configinteger name="port" required="false" desc="Port the DB is running on, if non-standard">5432</configinteger>
989
<configstring name="hostspec" desc="What hostname is the database server running on, or what is the name of the system DSN to use?">localhost</configstring>
990
<configstring name="username" desc="What username do we authenticate to the database server as?">horde</configstring>
991
<configstring name="password" required="false" desc="What password do we authenticate to the database server with?"/>
992
<configstring name="database" desc="What database name/tablespace are we using?">horde</configstring>
993
<configstring name="table" required="false" desc="The name of the session table in the database [horde_sessionhandler]"/>
996
<case name="oci8" desc="Oracle based sessions">
997
<configsection name="params">
998
<configboolean name="persistent" desc="Request persistent connections?">false</configboolean>
999
<configswitch name="protocol" desc="What protocol will we use to connect to the database?">unix
1000
<case name="unix" desc="UNIX Sockets">
1001
<configstring name="socket" required="false" desc="Location of UNIX socket"></configstring>
1003
<case name="tcp" desc="TCP/IP">
1004
<configinteger name="port" required="false" desc="Port the DB is running on, if non-standard">5432</configinteger>
1007
<configstring name="hostspec" desc="What hostname is the database server running on, or what is the name of the system DSN to use?">localhost</configstring>
1008
<configstring name="username" desc="What username do we authenticate to the database server as?">horde</configstring>
1009
<configstring name="password" required="false" desc="What password do we authenticate to the database server with?"/>
1010
<configstring name="database" desc="What database name/tablespace are we using?">horde</configstring>
1011
<configstring name="table" required="false" desc="The name of the session table in the database [horde_sessionhandler]"/>
1014
<case name="pgsql" desc="PostgreSQL based sessions">
1015
<configsection name="params">
1016
<configboolean name="persistent" desc="Request persistent connections?">false</configboolean>
1017
<configswitch name="protocol" desc="What protocol will we use to connect to the database?">unix
1018
<case name="unix" desc="UNIX Sockets">
1019
<configstring name="socket" required="false" desc="Location of UNIX socket"></configstring>
1021
<case name="tcp" desc="TCP/IP">
1022
<configinteger name="port" required="false" desc="Port the DB is running on, if non-standard">5432</configinteger>
1025
<configstring name="hostspec" desc="What hostname is the database server running on, or what is the name of the system DSN to use?">localhost</configstring>
1026
<configstring name="username" desc="What username do we authenticate to the database server as?">horde</configstring>
1027
<configstring name="password" required="false" desc="What password do we authenticate to the database server with?"/>
1028
<configstring name="database" desc="What database name/tablespace are we using?">horde</configstring>
1029
<configstring name="table" required="false" desc="The name of the session table in the database [horde_sessionhandler]"/>
1032
<case name="sapdb" desc="Use PEAR's DB abstraction layer w/ODBC">
1033
<configsection name="params">
1034
<configstring name="hostspec" desc="What hostname is the database server running on, or what is the name of the system DSN to use?">localhost</configstring>
1035
<configstring name="username" desc="What username do we authenticate to the database server as?">horde</configstring>
1036
<configstring name="password" required="false" desc="What password do we authenticate to the database server with?"/>
1037
<configstring name="database" desc="What database name/tablespace are we using?">horde</configstring>
1038
<configstring name="table" desc="The name of the session table in the database"/>
1041
<case name="sql" desc="Use PEAR's DB abstraction layer">
1042
<configsection name="params">
1043
<configboolean name="persistent" desc="Request persistent connections?">false</configboolean>
1044
<configswitch name="protocol" desc="What protocol will we use to connect to the database?">unix
1045
<case name="unix" desc="UNIX Sockets">
1046
<configstring name="socket" required="false" desc="Location of UNIX socket"></configstring>
1048
<case name="tcp" desc="TCP/IP">
1049
<configinteger name="port" required="false" desc="Port the DB is running on, if non-standard">5432</configinteger>
1052
<configstring name="hostspec" desc="What hostname is the database server running on, or what is the name of the system DSN to use?">localhost</configstring>
1053
<configstring name="username" desc="What username do we authenticate to the database server as?">horde</configstring>
1054
<configstring name="password" required="false" desc="What password do we authenticate to the database server with?"/>
1055
<configstring name="database" desc="What database name/tablespace are we using?">horde</configstring>
1056
<configstring name="table" required="false" desc="The name of the session table in the database [horde_sessionhandler]"/>
1063
<configtab name="image" desc="Image Manipulation">
1064
<configsection name="image">
1065
<configheader>Image Manipulation</configheader>
1066
<configstring name="convert" required="false" desc="Horde requires either
1067
GD support built-in to PHP (--with-gd) or the ImageMagick software
1068
package (http://www.imagemagick.org/) to do image
1069
manipulation/creation. If using ImageMagick, specify the full path
1070
name to the 'convert' program. On Windows, this path *cannot* have
1071
spaces in it. Use DOS-style abbreviations if necessary: Progra~1
1072
instead of Program Files, for instance. If using GD, or using
1073
neither, leave this field blank."/>
1077
<configtab name="geoip" desc="Hostname->Country Lookup">
1078
<configsection name="geoip">
1079
<configheader>Hostname->Country Lookup</configheader>
1080
<configstring name="datafile" required="false" desc="Horde, by default, can
1081
do Hostname -> Country lookup using the top level domain (e.g. 'uk',
1082
'de') of the hostname. However, many popular top level domains
1083
(e.g. 'com', 'net') span more than one country. In these instances, Horde
1084
can use the MaxMind GeoIP Hostname to Country lookup to try to determine
1085
the correct country. To activate this functionality, the GeoIP.dat country
1086
database must be present on your local system. This file can be downloaded
1087
free of charge from http://www.maxmind.com/download/geoip/database/. If
1088
this database is present, specify the full path name to the database below.
1089
If empty, the GeoIP lookup will not be performed."/>
1093
<configtab name="problems" desc="Problem Reporting">
1094
<configsection name="problems">
1095
<configheader>Problem Reporting</configheader>
1096
<configstring name="email" desc="If problem reporting is enabled in an
1097
application's menu, where should problem report emails be
1098
sent?">webmaster@example.com</configstring>
1102
<configtab name="menu" desc="Menu settings">
1103
<configheader>Menu settings</configheader>
1104
<configsection name="menu">
1105
<configboolean name="always" desc="Should we <b>always</b>
1106
display the Horde frameset?">false</configboolean>
1108
<configsection name="links">
1109
<configenum name="help" desc="Should we display help links in the
1112
<value desc="All users">all</value>
1113
<value desc="Authenticated users">authenticated</value>
1114
<value desc="Never">never</value>
1117
<configenum name="options" desc="Should we display options links in the
1118
menu?">authenticated
1120
<value desc="All users">all</value>
1121
<value desc="Authenticated users">authenticated</value>
1122
<value desc="Never">never</value>
1125
<configenum name="problem" desc="Should we display problem reporting links
1128
<value desc="All users">all</value>
1129
<value desc="Authenticated users">authenticated</value>
1130
<value desc="Never">never</value>
1133
<configenum name="login" desc="Should we display a login link in the menu
1134
when not logged in?">all
1136
<value desc="All users">all</value>
1137
<value desc="Never">never</value>
1140
<configenum name="logout" desc="Should we display a logout link in the
1141
menu when logged in?">authenticated
1143
<value desc="Authenticated users">authenticated</value>
1144
<value desc="Never">never</value>
1147
<configenum name="login" desc="Should we display a login link in the menu
1148
when not logged in?">all
1150
<value desc="All users">all</value>
1151
<value desc="Never">never</value>
1154
<configenum name="logout" desc="Should we display a logout link in the
1155
menu when logged in?">authenticated
1157
<value desc="Authenticated users">authenticated</value>
1158
<value desc="Never">never</value>
1164
<configsection name="logo">
1165
<configstring name="image" required="false" desc="The URL of an image for
1166
the top of the Horde menu. The image should be no larger than 140 pixels
1167
wide by 40 pixels high to prevent the frame from scrolling."/>
1168
<configstring name="link" required="false" desc="If a logo is displayed in
1169
the Horde menu, what URL (if any) should it link to?"/>
1173
<configtab name="hooks" desc="Custom Function Hooks">
1174
<configsection name="hooks">
1175
<configheader>Custom Function Hooks</configheader>
1177
There are example functions for all hooks in horde/config/hooks.php.dist.
1178
</configdescription>
1179
<configboolean name="username" desc="If this is checked, the function
1180
_username_hook_frombackend() will be used to set the user name at login
1181
time. The counterpart function _username_hook_tobackend() will be used to
1182
convert user names back, for example when showing name lists to the
1183
user.">false</configboolean>
1184
<configboolean name="preauthenticate" desc="If this is checked and the
1185
function _horde_hook_preauthenticate() returns false, authentication will
1186
fail.">false</configboolean>
1187
<configboolean name="postauthenticate" desc="If this is checked and the
1188
function _horde_hook_postauthenticate() returns false, authentication will
1189
fail.">false</configboolean>
1190
<configboolean name="authldap" desc="If this is checked, the function
1191
_horde_hook_authldap() will be used to create and set the attributes needed
1192
to add/edit/delete users by the LDAP Auth driver.">false</configboolean>
1196
<configtab name="block" desc="Portal Block Configuration">
1197
<configheader>Portal Block Configuration</configheader>
1198
<configsection name="weatherdotcom" description="weatherdotcom Block Configuration">
1200
Use of the weather.com block requires free registration for the XML
1201
feed at http://www.weather.com/services/xmloap.html.
1202
After registration, an email will be returned with the Partner ID and
1203
license key.<br / >
1204
NOTE: weather.com guidelines require registration and use of the returned
1205
values, but the application appears to function with any string values.
1206
</configdescription>
1207
<configstring name="partner_id" required="false" desc="The partner I.D.
1209
<configstring name="license_key" required="false" desc="The license key
1212
<configsection name="fortune" description="Fortune Block Configuration,
1213
e.g. /usr/games/fortune">
1214
<configstring name="exec_path" required="false" desc="Path to fortune
1219
<configtab name="kolab" desc="Kolab Groupware Server">
1220
<configsection name="kolab">
1222
<div style="text-align:center"><b>*** IF YOU HAVE NO IDEA WHAT
1223
KOLAB IS THEN YOU CAN SAFELY IGNORE THIS TAB ***</b></div>
1224
Kolab is in no way required for normal Horde usage. If, however, you intend
1225
to use Horde as a webclient for Kolab then you will need to ensure that the
1226
following fields correspond to those required by your Kolab installation.
1227
You can find some of the required values in the <code>
1228
$KOLAB_ROOT/etc/kolab/kolab.conf</code> configuration file. Please
1229
note that the old iCal/vCard storage format has been dropped in favour of
1230
the new XML storage format & IMAP folder annotations; subsequently the
1231
Horde Kolab modules will only work with version 2 of the Kolab server.
1232
<div style="text-align:center">If you would like to find out more
1233
about Kolab then please visit the Kolab community website at
1234
http://www.kolab.org/</div>
1235
</configdescription>
1236
<configswitch name="enabled" quote="false" desc="Horde/Kolab integration status">false
1237
<case name="false" desc="Disabled" />
1238
<case name="true" desc="Enabled">
1239
<configheader>Kolab LDAP Server Settings</configheader>
1240
<configsection name="ldap">
1241
<configstring name="server" desc="Server address:">localhost</configstring>
1242
<configinteger name="port" desc="Server port:">389</configinteger>
1243
<configstring name="basedn" desc="Base DN:">dc=example, dc=com</configstring>
1244
<configstring name="binddn" desc="Bind DN:">cn=manager, dc=example, dc=com</configstring>
1245
<configstring name="bindpw" desc="Bind Password:">password</configstring>
1247
<configheader>Kolab Cyrus IMAP Server Settings</configheader>
1248
<configsection name="imap">
1249
<configstring name="server" desc="Server address:">localhost</configstring>
1250
<configinteger name="port" desc="Server port:">143</configinteger>
1251
<configinteger name="sieveport" desc="Sieve port:">2000</configinteger>
1252
<configstring name="maildomain" desc="Default maildomain:">example.com</configstring>
1253
<configstring name="adminuser" desc="Administrator user:">manager</configstring>
1254
<configstring name="adminpw" desc="Administrator password:">password</configstring>
1255
<configboolean name="virtdomains" desc="Virtual domains:">true</configboolean>
1257
<configheader>Kolab SMTP Server Settings</configheader>
1258
<configsection name="smtp">
1259
<configstring name="server" desc="Server address:">localhost</configstring>
1260
<configinteger name="port" desc="Server port:">25</configinteger>
added
removed
config/conf.xml
