[cvs] [Wiki] changed: FAQ/Admin/Config

Jan Schneider jan at horde.org
Mon Sep 17 16:27:35 UTC 2007


jan  Mon, 17 Sep 2007 09:27:35 -0700

Modified page: http://wiki.horde.org/FAQ/Admin/Config
New Revision:  4.17
Change log:  More cleanups and tweaks

@@ -74,13 +74,9 @@
     'initial_page' => 'login.php',
     'name' => _("Horde"),
 </code>

-Finally, change the Horde configuration in the {{General}} tab of the setup
interface (Horde 3.x), or modify the file {{horde/config/conf.php}} manually
to change the cookie path from {{'/horde'}} to {{'/'}} as in:
-
-<code type="php">
-$conf['cookie']['path'] = '/';
-</code>
+Finally, change the Horde configuration in the //General// tab of the setup
interface to change the cookie path from {{'/horde'}} to {{'/'}}.

 +++ How can I change the appearance?

 See ((Doc/Dev/Layout)) and ((Doc/Dev/Themes)).
@@ -114,13 +110,13 @@
 Horde uses GNU gettext for internationalization (i18n) and localization
(l10n). See {{horde/po/README}} and
{{[http://www.horde.org/horde/docs/?f=TRANSLATIONS.html
horde/docs/TRANSLATIONS]}} for more information.

 +++ How do I let users report problems directly from Horde?

-Horde comes with a problem-reporting form. You can control who sees it, and
what is done with problem reports, by going to the //Problem Reporting// tab
of the Horde Configuration tool.
+Horde comes with a problem-reporting form. You can control who sees it, and
what is done with problem reports, by going to the //Problem Reporting// tab
of the Horde setup interface.

 +++ Can I use PHP's safe_mode with Horde?

-PHP's safe_mode is not officially supported by Horde, although we work
around its restrictions wherever we can. Many have tried to use it, and have
reported various levels of success. To run in safe_mode you will need to
modify the PHP safe_mode settings. You may also have to change some code in
Horde or other Horde components in order to make things work properly. Some
of the known issues are not being able to set php maximum execution time,
problems with spell checking, not being able to use Sendmail (without
modifying the php safe_mode configuration), and problems with any sort of
file uploads (adding attachments in IMP, file uploads in Gollem, etc).
+PHP's safe_mode is not officially supported by Horde, although we work
around its restrictions wherever we can. Many have tried to use it, and have
reported various levels of success. To run in safe_mode you will need to
modify the PHP safe_mode settings. You may also have to change some code in
Horde or other Horde components in order to make things work properly. Some
of the known issues are not being able to set PHP maximum execution time,
problems with spell checking, not being able to use Sendmail (without
modifying the php safe_mode configuration), and problems with any sort of
file uploads (adding attachments in IMP, file uploads in Gollem, etc).

 If you run the Apache web server with virtual hosts and with PHP's
safe_mode enabled by default, you can use the Apache PHP module
configuration command {{php_admin_value}} in your main Apache configuration
file to remove safe_mode for the Horde virtual host. For example:

 <code>
@@ -203,9 +199,9 @@
 Horde is very flexible in how it can authenticate users, allowing for many
different types of authentication. Because of this, there is no single
answer for how you authenticate users; the answer will depend on your
particular setup and needs.

 In most cases, you will want to use an existing user database. If not, you
will need to create a new user database of some sort on your own.

-Once you know what type of user database you want to use, you must
configure Horde and possibly some other Horde applications (like IMP,
gollem, etc) to use that authentication source. For Horde, you do this in
the {{Authentication}} tab of the setup interface. If you choose to use IMP
to authenticate users (e.g. by having IMP log into the IMAP or POP3 server)
you must configure {{horde/imp/config/servers.php}} appropriately also.
+Once you know what type of user database you want to use, you must
configure Horde and possibly some other Horde applications (like IMP,
gollem, etc) to use that authentication source. For Horde, you do this in
the //Authentication// tab of the setup interface. If you choose to use IMP
to authenticate users (e.g. by having IMP log into the IMAP or POP3 server)
you must configure {{horde/imp/config/servers.php}} appropriately also.

 Some special notes for some of the authentication methods are:

 * If using the sql backend with the {{horde_users}} table, the password
must be in md5() format (and not the !MySQL password() format, for example).
@@ -224,9 +220,9 @@
 ++ IMP configuration

 +++ Can a single IMP installation serve different virtual hosts?

-If you have your webserver set up to answer requests from multiple domains,
you can use those virtual hosts to ensure that mail is sent with the
appropriate From: header. In other words, when someone goes to
+If you have your web server set up to answer requests from multiple
domains, you can use those virtual hosts to ensure that mail is sent with
the appropriate From: header. In other words, when someone goes to

 <code>
 http://example.com/webmail/
 </code>
@@ -238,118 +234,21 @@
 </code>

 mail will be sent from //username at example.net//.

-**[IMP 3.x]:** It is possible in IMP 3.x to use virtual hosts, but at this
time we have no instructions for doing so. You can check the IMP mailing
list archives for information.
+You can check the IMP mailing list archives for information.

 +++ How can I restrict what my users can do with IMP?

-**[IMP 2.2]:** There are a number of IMP features and functions which can
be disabled in imp's configuration file,
{{/horde/imp/config/defaults.php3}}.
+There are a number of IMP features and functions which can be disabled in
IMP's setup interface and in the file {{/horde/imp/config/prefs.php}}. See
the comments in the interface and this file for more information.

-They are:
-
-* Disable New User introduction
-
-<code type="php">
-$default->newuser_link          = false;
-</code>
-
-* Use fewer new browser windows
-
-<code type="php">
-$default->minimum_popups        = true;
-</code>
-
-* Do not allow user to choose IMAP server
-
-<code type="php">
-$default->user_change_server    = false;
-</code>
-
-* Only allow user to choose from servers listed in
/horde/imp/config/servers.php3
-
-<code type="php">
-$default->use_server_list       = true;
-</code>
-
-* Do not allow user to choose IMAP port
-
-<code type="php">
-$default->user_change_port      = false;
-</code>
-
-* Do not allow user to choose between POP3 and IMAP
-
-<code type="php">
-$default->user_change_servtype  = false;
-</code>
-
-* Do not allow user to use mail folders other than INBOX
-
-<code type="php">
-$default->user_use_folders      = false;
-</code>
-
-* Do not allow user to specify folder directory at login
-
-<code type="php">
-$default->user_change_folder    = false;
-</code>
-
-* Do not allow user to subscribe/unsubscribe IMAP folders (i.e., use all
folders present)
-
-<code type="php">
-$default->use_imap_subscribe    = false;
-</code>
-
-* Disable UW-IMAP's #shared, #public and #news hierarchy:
-
-<code type="php">
-$default->show_shared_hierarchy = false;
-$default->show_public_hierarchy = false;
-$default->show_news_hierarchy   = false;
-</code>
-
-* Refrain from saving copies of outgoing mail
-
-<code type="php">
-$default->save_sent_mail         = false;
-</code>
-
-* Disable "You have new mail" popup window
-
-<code type="php">
-$default->newmail_popup          = false;
-</code>
-
-* Do not allow user to select language
-
-<code type="php">
-$default->user_change_language   = false
-</code>
-
-* Do not allow user to change their From: header or their full name
-
-<code type="php">
-$default->user_change_from      = false;
-$default->user_change_fullname  = false;
-</code>
-
-* Disable address book feature
-
-<code type="php">
-$default->user_use_addressbook   = false;
-</code>
-
-**[IMP 3.x]:** IMP 3.x contains similar functionality in the files
{{horde/imp/config/conf.php}} and {{/horde/imp/config/prefs.php}}. See the
comments in those files for more information.
-
-When changing settings in {{/horde/imp/config/prefs.php}} you can set the
"value" field for a preference to set the default value of that preference.
If you want to force users to use that value, and not allow them to change
it, you must also set the "locked" field to //true//.
+When changing settings in {{/horde/imp/config/prefs.php}} you can set the
"value" field for a preference to set the default value of that preference.
If you want to force users to use that value, and not allow them to change
it, you must also set the {{'locked'}} field to {{true}}.

 +++ How can I configure IMP's maximum attachment size?

 You may need to make changes to any or all of the following settings:  PHP,
Apache, database, and Mail Transfer Agent.  Settings in each of these parts
may affect overall attachment size and you will likely want any value that
deals with size to be set to the same value of whatever maximum size you
want to support.

-By default, PHP limits uploaded files to 2 MB, and this limit applies to
attachments on messages sent from IMP. To change this value, edit the
following value in your {{php.ini}} (or, in PHP3, {{php3.ini}}):
+By default, PHP limits uploaded files to 2 MB, and this limit applies to
attachments on messages sent from IMP. To change this value, edit the
following value in your {{php.ini}}:

 <code>
 upload_max_filesize = number of bytes
 post_max_size = number of bytes + size of form data, e.g. message text
@@ -363,23 +262,29 @@
 </code>

 You will need to restart your web server after this change.

-It is also possible that web server settings may limit the size of
attachments.  For example, the Apache setting {{!LimitRequestBody}} will
limit the size also.  In some linux distributions (e.g. Red Hat Enterprise
Linux 3), this is set very low in a distribution created
{{/etc/httpd/conf.d/php.conf}} file.  Again, you will need to restart your
web server after changing web server configuration settings.
+A few of these settings can also be changed through Horde's setup interface
and override the default PHP settings.
+
+It is also possible that web server settings may limit the size of
attachments.  For example, the Apache setting {{!LimitRequestBody}} will
limit the size also.  In some Linux distributions (e.g. Red Hat Enterprise
Linux 3), this is set very low in a distribution-created
{{/etc/httpd/conf.d/php.conf}} file.  Again, you will need to restart your
web server after changing web server configuration settings.

 Your database server may impose limits on the maximum size of files that
can be uploaded.  Check your database server documentation to see what this
limit may be.  For !MySQL, this limit is controlled by the
{{max_allowed_packet}} configuration directive.

 Finally, your MTA may impose size limits for the overall size of messages
that it will handle.  Check your MTA configuration to see if there are
settings to limit overall message size.

 +++ Can I add a custom header to mail sent from IMP?

-To add custom SMTP headers to mail sent from IMP, place the headers in
{{/horde/imp/config/header.txt}}. Make sure that your header is the last
line in the file! You can include PHP variables by enclosing them in percent
signs ("%"). One useful header is
+To add custom SMTP headers to mail sent from IMP, place the headers in
{{/horde/imp/config/header.txt}} ({{/horde/imp/config/header.php}} in IMP
4.1 or higher). Make sure that your header is the last line in the file!
+
+**[IMP 4.0]:** You can include PHP variables by enclosing them in percent
signs ("%"). One useful header is

 <code>
 X-Originating-IP: %REMOTE_ADDR%
 </code>

 which follows a de-facto standard adhered to by Hotmail, Yahoo Mail, and
Dejanews (to name but a few) of listing the address of the computer at which
the mail message was composed.
+
+**[IMP 4.1+]**: You can enter any valid PHP expressions.

 Note that these are //email headers//, not body text. If you want to add an
advertisement for your webmail service, or a similar announcement, to
outgoing mail, put it at the bottom of the message (which is the standard
location) by placing the text in {{/horde/imp/config/tailer.txt}}.

 +++ Where can I find foreign-language dictionaries for spellcheck?
@@ -395,82 +300,63 @@
 Note that you can not use folders with POP3 as the POP3 protocol does not
contain any support for folders. If you want to use folders then you must
configure IMP to use IMAP rather than POP3 access.

 +++ Can IMP show attachments or html inline?

-IMP is //capable// of showing certain attachments inline (i.e., in the
message body, rather than appearing in a new window on request), but in some
cases it risks exposing the user to a security problem in the browser: by
enabling inline HTML, any javascript (!ActiveX, Java, etc.) in the
attachment will be executed by the browser. //Enabling inline HTML
attachments is strongly discouraged//.
+IMP is //capable// of showing certain attachments inline (i.e., in the
message body, rather than appearing in a new window on request), but in some
cases it risks exposing the user to a security problem in the browser: by
enabling inline HTML, any JavaScript (!ActiveX, Java, etc.) in the
attachment might be executed by the browser. We try to filter out any active
content, but just like with any filter, it might not be perfect and let some
code through. //Enabling inline HTML attachments is discouraged//.

 Of course, this will only work for elements that could be part of a regular
HTML page. In particular, images //cannot// be part of in a regular HTML
page (they have to be a separate file with an <IMG> tag to include them in
an HTML page), and can thus not be inlined.

-Edit the file {{horde/imp/config/mime_drivers.php}} to enable inline
support for the mime types you wish to have displayed inline. Simply set the
'inline' array element for that mime type to 'true' to enable a type. As
noted above, not all mime types can be shown inline; if there is no 'inline'
array element for a mime type than that type can not be viewed inline.
+Edit the files {{horde/config/mime_drivers.php}} and
{{horde/imp/config/mime_drivers.php}} to enable inline support for the mime
types you wish to have displayed inline. Simply set the {{'inline'}} array
element for that mime type to {{true}} to enable a type. As noted above, not
all mime types can be shown inline; if there is no {{'inline'}} array
element for a mime type than that type can not be viewed inline.

-For example, to enable inline html support you would set:
+For example, to enable inline HTML support you would set:

 <code type="php">
 $mime_drivers['imp']['html']['inline'] = true;
 </code>

 +++ How can I use LDAP for IMP's contact list?

-For LDAP searches to work in IMP, LDAP support must have been compiled into
PHP.
+IMP has no built-in address book, but instead uses the Horde module Turba
for an address book. See the Turba FAQ section for information on
configuring Turba for LDAP support. You must have Turba installed and
working before you configure IMP to use it for address books.

-**[IMP 3+]:** IMP 3.x no longer has a built-in address book, but instead
uses the Horde module Turba for an address book. See the Turba faq section
for information on configuring Turba for LDAP support. You must have Turba
installed and working before you configure IMP to use it for address books.
-
-To configure IMP to use one or more Turba directories, you modify the file
{{horde/imp/config/prefs.php}} to set the value of the
{{$_prefs['search_sources']}} array. The 'value' field of this array needs
to be set to a tab delimited set of Turba directory sources. IMP will then
use these sources for directory lookups.
+To configure IMP to use one or more Turba directories by default, you
modify the file {{horde/imp/config/prefs.php}} to set the value of the
{{$_prefs['search_sources']}} array. The {{'value'}} field of this array
needs to be set to a tab delimited set of Turba directory sources. IMP will
then use these sources for directory lookups.

 +++ How can I let users change their password through IMP?

-**[IMP 3+]:** Since version 3.x IMP does not include support for changing
passwords. You can download a seperate Horde module called
[http://www.horde.org/passwd/ Passwd] to add this functionality.
+IMP does not include support for changing passwords. You can download a
separate Horde module called [http://www.horde.org/passwd/ Passwd] to add
this functionality.

 +++ How can I let users open new accounts through IMP?

-**[IMP 2.2]:** There is rudimentary account-signup functionality built into
Horde 1.2 (IMP 2.2), which will allow users to fill out a form to request an
account, and then send the collected data to a specified email address. To
enable it, set the following in {{horde/config/horde.php3}}:
-
-<code type="php">
-$default->signup = true;
-$default->signup_email = 'address which receives account requests';
-</code>
-
-There is currently no automated account creation facility in IMP. If you
feel you are capable of writing this (meaning that you know how to write
secure setuid programs!), look at {{horde/signup.php3}}. Keep in mind that
allowing users to create accounts without any sort of admin authorization
might not be a good thing.
-
-**[IMP 3.x]:** This functionality is not available in Horde 2.x or IMP 3.x
at this time.
+There is some signup functionality in Horde that requires an authentication
backend that can be managed through Horde. Signups have to be enabled in the
Horde setup interface.

 +++ How can I remove maintenance functions in IMP?

 **[IMP 3.0]:** You need to disable each maintenance function individually.
You can do so by editing the file {{horde/imp/config/prefs.php}}. You need
to locate the stanzas for rename_sentmail_monthly, delete_sentmail_monthly,
delete_sentmail_monthly_keep, purge_trash, purge_trash_interval, and
purge_trash_keep.

-For each stanza, set the 'value' field to 0 (zero) and the 'locked' field
to true.
+For each stanza, set the {{'value'}} field to {{0}} (zero) and the
{{'locked'}} field to {{true}}.

-**[IMP 3.1]:** To disable the maintenance functions by default for all
users (but still allow individual users to choose to turn it back on) edit
{{horde/imp/config/prefs.php}}, locate the stanza for
{{$_prefs['do_maintenance']}}, and set the 'value' field to 0 (zero).
+**[IMP 3.1+]:** To disable the maintenance functions by default for all
users (but still allow individual users to choose to turn it back on) edit
{{horde/imp/config/prefs.php}}, locate the stanza for
{{$_prefs['do_maintenance']}}, and set the {{'value'}} field to {{0}}
(zero).

-To prevent maintenance functions completely (so even individual users can
not enable it for themselves), simply edit {{horde/imp/config/prefs.php}},
locate the stanza for {{$_prefs['do_maintenance']}}, and set the 'value'
field to 0 (zero) and the 'locked' field to true.
+To prevent maintenance functions completely (so even individual users can
not enable it for themselves), simply edit {{horde/imp/config/prefs.php}},
locate the stanza for {{$_prefs['do_maintenance']}}, and set the {{'value'}}
field to {{0}} (zero) and the {{'locked'}} field to {{true}}.

 +++ Why doesn't the Options button show up in IMP?

-**[IMP 3.x]:** In order for the **Options** button to show up, you need to
make sure you have created a preferences storage container. This means you
must have either a database or LDAP backend in place and configured. For
more information see the file
{{[http://www.horde.org/horde/docs/?f=INSTALL.html horde/docs/INSTALL]}}.
+In order for the **Options** button to show up, you need to make sure you
have created a preferences storage container. This means you must have
either a database or LDAP backend in place and configured. For more
information see the file {{[http://www.horde.org/horde/docs/?f=INSTALL.html
horde/docs/INSTALL]}}.

 You will also have to configure Horde to use the preferences container.
This is done in the //Preference System Settings// section of the file
{{horde/config/horde.php}}.

 +++ Can IMP be used with SMTP authentication?

-**[IMP 3.x]:** Horde and IMP can support SMTP authentication, but only if
the SMTP server take the same authentication credentials as the POP/IMAP
server (which would generally be the case). Simply edit
{{horde/config/horde.php}} as per the comments in that file, e.g.
-
-<code type="php">
-$conf['mailer']['params']['auth'] = true;
-</code>
+Horde and IMP can support SMTP authentication, but only if the SMTP server
take the same authentication credentials as the POP/IMAP server (which would
generally be the case). Simply edit the Horde configuration as per the
comments in the //Mailer// tab of the setup interface.

 +++ How can I remove or change the text appended to each email sent through
IMP?

-**[IMP 3.x]:** IMP automatically appends the content of the file
{{horde/imp/config/trailer.txt}} to each email it sends. You can disable
this by setting the configuration option {{$conf['msg']['append_trailer']}}
to false in your {{horde/imp/config/conf.php}} file. If enabled, you can
change the message by simply editing the contents of
{{horde/imp/config/trailer.txt}} to suit your needs. Please note that this
is a text file, and should not contain html or php code but only normal
text.
+IMP automatically appends the content of the file
{{horde/imp/config/trailer.txt}} to each email it sends. You can disable
this by disabling the according configuration option in IMP's setup
interface. If enabled, you can change the message by simply editing the
contents of {{horde/imp/config/trailer.txt}} to suit your needs. Please note
that this is a text file, and should not contain HTML or PHP code but only
normal text.

 ++ Turba Configuration
-
-+++ How do I migrate my IMP 2.x contacts to Turba?
-
-Use the script {{imp/scripts/imp2turba.pl}} from IMP 3.x (requires perl
with appropriate sql support).

 +++ How can I use LDAP for IMP's contact list?

-You need to modify {{horde/turba/config/sources.php}} to specify your ldap
server and its attributes. The documentation in the file is pretty complete,
and there are some examples using public ldap directories.
+You need to modify {{horde/turba/config/sources.php}} to specify your LDAP
server and its attributes. The documentation in the file is pretty complete,
and there are some examples using public LDAP directories.

 +++ How do I enable shared address books?

-**[Turba 2.1]:** You can enable shared address book support for a source
that supports this (currently SQL sources only) by adding 'use_shares' =>
true to the source's stanza in sources.php.  This allows users to create and
delete new address books as well as manage permissions on the address books
that they own.  Permissions for shared address books should be set through
the My Address Books interface in Turba and **not** through the
administration interface.
+**[Turba 2.1+]:** You can enable shared address book support for a source
that supports this (currently SQL sources only) by adding {{'use_shares' =>
true}} to the source's stanza in {{horde/turba/config/sources.php}}. This
allows users to create and delete new address books as well as manage
permissions on the address books that they own. Permissions for shared
address books should be set through the //My Address Books// interface in
Turba and **not** through the administration interface.


More information about the cvs mailing list