zarafa-gateway.cfg

Langue: en

Version: May 2009 (fedora - 01/12/10)

Section: 5 (Format de fichier)

NAME

zarafa-gateway.cfg - The Zarafa gateway configuration file

SYNOPSIS

gateway.cfg

DESCRIPTION

The gateway.cfg is a configuration file for the Zarafa Gateway. gateway.cfg contains instructions for the software to set up the logging system and to enable or disable the POP3, POP3S, IMAP or IMAPS part of the service.

FILE FORMAT

The file consists of one big section, but parameters can be grouped by functionality.

The parameters are written in the form:

name = value

The file is line-based. Each newline-terminated line represents either a comment, nothing, a parameter or a directive. A line beginning with `#' is considered a comment, and will be ignored by Zarafa. Parameter names are case sensitive. Lines beginning with `!' are directives.

Directives are written in the form:

!directive [argument(s)]

The following directives exist:

include

Include and process argument
Example: !include common.cfg

EXPLANATION OF EACH PARAMETER

server_bind

IP address to bind to. 0.0.0.0 for any address.
Default: 0.0.0.0

pop3_enable

Enable POP3 service with value yes. All other values disable the service.
Default: yes

pop3_port

The POP3 service will listen on this port for incoming connections.
Default: 110

pop3s_enable

Enable POP3S service with value yes. All other values disable the service.
Default: yes

pop3s_port

The POP3S service will listen on this port for incoming connections.
Default: 995

imap_enable

Enable IMAP service with value yes. All other values disable the service.
Default: yes

imap_port

The IMAP service will listen on this port for incoming connections.
Default: 143

imaps_enable

Enable IMAPS service with value yes. All other values disable the service.
Default: yes

imaps_port

The IMAPS service will listen on this port for incoming connections.
Default: 993

server_socket

The http address of the Zarafa server.
Default: http://localhost:236/zarafa

run_as_user

After correctly starting, the gateway process will become this user, dropping root privileges. Note that the log file needs to be writeable by this user, and the directory too to create new logfiles after logrotation. This can also be achieved by setting the correct group and permissions.
Default value is empty, not changing the user after starting.

run_as_group

After correctly starting, the gateway process will become this group, dropping root privileges.
Default value is empty, not changing the group after starting.

pid_file

Write the process ID number to this file. This is used by the init.d script to correctly stop/restart the service.
Default: /var/run/zarafa-gateway.pid

running_path

Change directory to this path when running in daemonize mode. When using the -F switch to run in the foreground the directory will not be changed.
Default: /

process_model

You can change the process model between fork and thread. The forked model uses somewhat more resources, but if an crash is triggered, this will only affect one user. In the threaded model, a crash means all users are affected, and will not be able to use the service.
Default: fork

imap_only_mailfolders

Enable the IMAP and IMAPS service to only show the mailfolders. This is the default behaviour. When this option is set to 'no', you will also be able to select you calendar and contacts and such. These views will not contain all information, since these items cannot be converted to a rfc-822 mail item.
Default: yes

imap_public_folders

Enable the IMAP and IMAPS service to also show the public store with subfolders. This is the default behaviour. When this option is set to 'no', IMAP clients will only see the users' folder.
Default: yes

imap_capability_idle

Allow IMAP clients to issue the IDLE command. When an IMAP client is idle, it may receive notifications from the server about changes of the selected folder. This may increase load on the server when many users are using the IMAP service.
Default: yes

imap_always_generate

The gateway contains an optimization for some queries. However, this optimization is not 100% legal, and may introduce problems to some client. One of the known clients to have problems with this optimization are Mac Mail clients. If you experience problems while reading email (where you see raw SMTP bodies), try turning this option on.
Default: no

imap_max_messagesize

Limit the maximum message size (in bytes) which can be created by an IMAP client. The maximum of this value is 4GB although this is not recommended. If the value is too high it will cause a segmentation fault.
Default: 134217728

ssl_private_key_file

The gateway will use this file as private key for SSL TLS. This file can be created with: openssl genrsa -out /etc/zarafa/gateway/privkey.pem 2048.
Default: /etc/zarafa/gateway/privkey.pem

ssl_certificate_file

The gateway will use this file as certificate for SSL TLS. A self-signed certificate can be created with: openssl req -new -x509 -key /etc/zarafa/gateway/privkey.pem -out /etc/zarafa/gateway/cert.pem -days 1095.
Default: /etc/zarafa/gateway/cert.pem

ssl_verify_client

Enable client certificate verification with value yes. All other values disable the verification.
Default: no

ssl_verify_file

The file to verify the clients certificates with.
Default: value not set.

ssl_verify_path

The path with the files to verify the clients certificates with.
Default: value not set.

log_method

The method which should be used for logging. Valid values are:
syslog
Use the Linux system log. All messages will be written to the mail facility. See also syslog.conf(5).

file

Log to a file. The filename will be specified in log_file.

Default: file

log_file

When logging to a file, specify the filename in this parameter. Use - (minus sign) for stderr output.
Default: -

log_level

The level of output for logging in the range from 0 to 5. 0=no logging, 5=full logging.
Default: 2

log_timestamp

Specify whether to prefix each log line with a timestamp in 'file' logging mode.
Default: 1

RELOADING

The following options are reloadable by sending the zarafa-gateway process a HUP signal:

log_level

FILES

/etc/zarafa/gateway.cfg

The Zarafa gateway configuration file.

AUTHOR

Written by Zarafa.

SEE ALSO

zarafa-gateway(1)