How-to Wiki

Roundcube Webmail Installer

  1. Check environment
  2. Create config
  3. Test config
General configuration
product_name
The name of your service (used to compose page titles)
support_url
Provide an URL where a user can get support for this Roundcube installation.
PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE!

Enter an absolute URL (including http://) to a support page/form or a mailto: link.

skin_logo
Custom image to display instead of the Roundcube logo.

Enter a URL relative to the document root of this Roundcube installation.

temp_dir
Use this folder to store temp files (must be writeable for webserver)
des_key
This key is used to encrypt the users imap password before storing in the session record

It's a random generated string to ensure that every installation has its own key.

ip_check

This increases security but can cause sudden logouts when someone uses a proxy with changing IPs.

enable_spellcheck

spellcheck_engine

Googie implies that the message content will be sent to external server to check the spelling.

identities_level
Level of identities access

Defines what users can do with their identities.

Logging & Debugging
debug_level


log_driver
How to do logging? 'file' - write to files in the log directory, 'syslog' - use the syslog facility, 'stdout' writes to the process' STDOUT file descriptor.
log_dir
Use this folder to store log files (must be writeable for webserver). Note that this only applies if you are using the 'file' log_driver.
syslog_id
What ID to use when logging with syslog. Note that this only applies if you are using the 'syslog' log_driver.
syslog_facility
What ID to use when logging with syslog. Note that this only applies if you are using the 'syslog' log_driver.
Database setup
db_dsnw

Database settings for read/write operations:






db_prefix
Optional prefix that will be added to database object names (tables and sequences).
IMAP Settings
default_host
The IMAP host(s) chosen to perform the log-in

Leave blank to show a textbox at login. To use SSL/IMAPS connection, type ssl://hostname

default_port
TCP port used for IMAP connections
username_domain
Automatically add this domain to user names for login

Only for IMAP servers that require full e-mail addresses for login

auto_create_user

A user is authenticated by the IMAP server but it requires a local record to store settings and contacts. With this option enabled a new user record will automatically be created once the IMAP login succeeds.

If this option is disabled, the login only succeeds if there's a matching user-record in the local Roundcube database what means that you have to create those records manually or disable this option after the first login.

sent_mbox
Store sent messages in this folder

Leave blank if sent messages should not be stored. Note: folder must include namespace prefix if any.

trash_mbox
Move messages to this folder when deleting them

Leave blank if they should be deleted directly. Note: folder must include namespace prefix if any.

drafts_mbox
Store draft messages in this folder

Leave blank if they should not be stored. Note: folder must include namespace prefix if any.

junk_mbox
Store spam messages in this folder

Note: folder must include namespace prefix if any.

SMTP Settings
smtp_server
Use this host for sending mails

To use SSL connection, set ssl://smtp.host.com.

smtp_port
SMTP port (default is 25; 465 for SSL; 587 for submission)
smtp_user/smtp_pass
SMTP username and password (if required)

smtp_log

Display settings & user prefs
language *
The default locale setting. This also defines the language of the login screen.
Leave it empty to auto-detect the user agent language.

Enter a RFC1766 formatted language name. Examples: en_US, de_DE, de_CH, fr_FR, pt_BR

skin *
Name of interface skin (folder in /skins)
mail_pagesize *
Show up to X items in the mail messages list view.
addressbook_pagesize *
Show up to X items in the contacts list view.
prefer_html *

htmleditor *
draft_autosave *
mdn_requests *
Behavior if a received message requests a message delivery notification (read receipt)
mime_param_folding *
How to encode attachment long/non-ascii names

*  These settings are defaults for the user preferences

Plugins


































Please consider checking dependencies of enabled plugins