1 <form action="index.php" method="post">
2 <input type="hidden" name="_step" value="2" />
5 // also load the default config to fill in the fields
8 // register these boolean fields
9 $RCI->bool_config_props = array(
11 'enable_caching' => 1,
12 'enable_spellcheck' => 1,
13 'auto_create_user' => 1,
20 // allow the current user to get to the next step
21 $_SESSION['allowinstaller'] = true;
23 if (!empty($_POST['submit'])) {
25 echo '<p class="notice">Copy or download the following configurations and save them in two files';
26 echo ' (names above the text box) within the <tt>'.RCMAIL_CONFIG_DIR.'</tt> directory of your Roundcube installation.<br/>';
27 echo ' Make sure that there are no characters outside the <tt><?php ?></tt> brackets when saving the files.</p>';
29 $textbox = new html_textarea(array('rows' => 16, 'cols' => 60, 'class' => "configfile"));
31 echo '<div><em>main.inc.php (<a href="index.php?_getfile=main">download</a>)</em></div>';
32 echo $textbox->show(($_SESSION['main.inc.php'] = $RCI->create_config('main')));
34 echo '<div style="margin-top:1em"><em>db.inc.php (<a href="index.php?_getfile=db">download</a>)</em></div>';
35 echo $textbox->show($_SESSION['db.inc.php'] = $RCI->create_config('db'));
37 echo '<p class="hint">Of course there are more options to configure.
38 Have a look at the config files or visit <a href="http://trac.roundcube.net/wiki/Howto_Config">Howto_Config</a> to find out.</p>';
40 echo '<p><input type="button" onclick="location.href=\'./index.php?_step=3\'" value="CONTINUE" /></p>';
42 // echo '<style type="text/css"> .configblock { display:none } </style>';
43 echo "\n<hr style='margin-bottom:1.6em' />\n";
48 <legend>General configuration</legend>
49 <dl class="configblock">
51 <dt class="propname">product_name</dt>
55 $input_prodname = new html_inputfield(array('name' => '_product_name', 'size' => 30, 'id' => "cfgprodname"));
56 echo $input_prodname->show($RCI->getprop('product_name'));
59 <div>The name of your service (used to compose page titles)</div>
62 <dt class="propname">temp_dir</dt>
66 $input_tempdir = new html_inputfield(array('name' => '_temp_dir', 'size' => 30, 'id' => "cfgtempdir"));
67 echo $input_tempdir->show($RCI->getprop('temp_dir'));
70 <div>Use this folder to store temp files (must be writeable for webserver)</div>
74 <dt class="propname">ip_check</dt>
78 $check_ipcheck = new html_checkbox(array('name' => '_ip_check', 'id' => "cfgipcheck"));
79 echo $check_ipcheck->show(intval($RCI->getprop('ip_check')), array('value' => 1));
82 <label for="cfgipcheck">Check client IP in session authorization</label><br />
84 <p class="hint">This increases security but can cause sudden logouts when someone uses a proxy with changing IPs.</p>
87 <dt class="propname">des_key</dt>
91 $input_deskey = new html_inputfield(array('name' => '_des_key', 'size' => 30, 'id' => "cfgdeskey"));
92 echo $input_deskey->show($RCI->getprop('des_key'));
95 <div>This key is used to encrypt the users imap password before storing in the session record</div>
96 <p class="hint">It's a random generated string to ensure that every installation has its own key.
97 If you enter it manually please provide a string of exactly 24 chars.</p>
100 <dt class="propname">enable_caching</dt>
104 $check_caching = new html_checkbox(array('name' => '_enable_caching', 'id' => "cfgcache"));
105 echo $check_caching->show(intval($RCI->getprop('enable_caching')), array('value' => 1));
108 <label for="cfgcache">Cache messages in local database</label><br />
111 <dt class="propname">enable_spellcheck</dt>
114 $check_spell = new html_checkbox(array('name' => '_enable_spellcheck', 'id' => "cfgspellcheck"));
115 echo $check_spell->show(intval($RCI->getprop('enable_spellcheck')), array('value' => 1));
117 <label for="cfgspellcheck">Make use of the spell checker</label><br />
120 <dt class="propname">spellcheck_engine</dt>
123 $select_spell = new html_select(array('name' => '_spellcheck_engine', 'id' => "cfgspellcheckengine"));
124 if (extension_loaded('pspell'))
125 $select_spell->add('pspell', 'pspell');
126 $select_spell->add('Googie', 'googie');
128 echo $select_spell->show($RCI->is_post ? $_POST['_spellcheck_engine'] : 'pspell');
131 <label for="cfgspellcheckengine">Which spell checker to use</label><br />
133 <p class="hint">GoogieSpell implies that the message content will be sent to Google in order to check the spelling.</p>
136 <dt class="propname">identities_level</dt>
140 $input_ilevel = new html_select(array('name' => '_identities_level', 'id' => "cfgidentitieslevel"));
141 $input_ilevel->add('many identities with possibility to edit all params', 0);
142 $input_ilevel->add('many identities with possibility to edit all params but not email address', 1);
143 $input_ilevel->add('one identity with possibility to edit all params', 2);
144 $input_ilevel->add('one identity with possibility to edit all params but not email address', 3);
145 echo $input_ilevel->show($RCI->getprop('identities_level'), 0);
148 <div>Level of identities access</div>
149 <p class="hint">Defines what users can do with their identities.</p>
156 <legend>Logging & Debugging</legend>
157 <dl class="loggingblock">
159 <dt class="propname">debug_level</dt>
163 $value = $RCI->getprop('debug_level');
164 $check_debug = new html_checkbox(array('name' => '_debug_level[]'));
165 echo $check_debug->show(($value & 1) ? 1 : 0 , array('value' => 1, 'id' => 'cfgdebug1'));
166 echo '<label for="cfgdebug1">Log errors</label><br />';
168 echo $check_debug->show(($value & 4) ? 4 : 0, array('value' => 4, 'id' => 'cfgdebug4'));
169 echo '<label for="cfgdebug4">Print errors (to the browser)</label><br />';
171 echo $check_debug->show(($value & 8) ? 8 : 0, array('value' => 8, 'id' => 'cfgdebug8'));
172 echo '<label for="cfgdebug8">Verbose display (enables debug console)</label><br />';
177 <dt class="propname">log_driver</dt>
181 $select_log_driver = new html_select(array('name' => '_log_driver', 'id' => "cfglogdriver"));
182 $select_log_driver->add(array('file', 'syslog'), array('file', 'syslog'));
183 echo $select_log_driver->show($RCI->getprop('log_driver', 'file'));
186 <div>How to do logging? 'file' - write to files in the log directory, 'syslog' - use the syslog facility.</div>
189 <dt class="propname">log_dir</dt>
193 $input_logdir = new html_inputfield(array('name' => '_log_dir', 'size' => 30, 'id' => "cfglogdir"));
194 echo $input_logdir->show($RCI->getprop('log_dir'));
197 <div>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.</div>
200 <dt class="propname">syslog_id</dt>
204 $input_syslogid = new html_inputfield(array('name' => '_syslog_id', 'size' => 30, 'id' => "cfgsyslogid"));
205 echo $input_syslogid->show($RCI->getprop('syslog_id', 'roundcube'));
208 <div>What ID to use when logging with syslog. Note that this only applies if you are using the 'syslog' log_driver.</div>
211 <dt class="propname">syslog_facility</dt>
215 $input_syslogfacility = new html_select(array('name' => '_syslog_facility', 'id' => "cfgsyslogfacility"));
216 $input_syslogfacility->add('user-level messages', LOG_USER);
217 $input_syslogfacility->add('mail subsystem', LOG_MAIL);
218 $input_syslogfacility->add('local level 0', LOG_LOCAL0);
219 $input_syslogfacility->add('local level 1', LOG_LOCAL1);
220 $input_syslogfacility->add('local level 2', LOG_LOCAL2);
221 $input_syslogfacility->add('local level 3', LOG_LOCAL3);
222 $input_syslogfacility->add('local level 4', LOG_LOCAL4);
223 $input_syslogfacility->add('local level 5', LOG_LOCAL5);
224 $input_syslogfacility->add('local level 6', LOG_LOCAL6);
225 $input_syslogfacility->add('local level 7', LOG_LOCAL7);
226 echo $input_syslogfacility->show($RCI->getprop('syslog_facility'), LOG_USER);
229 <div>What ID to use when logging with syslog. Note that this only applies if you are using the 'syslog' log_driver.</div>
240 <legend>Database setup</legend>
241 <dl class="configblock" id="cgfblockdb">
242 <dt class="propname">db_dsnw</dt>
244 <p>Database settings for read/write operations:</p>
247 require_once 'MDB2.php';
249 $supported_dbs = array('MySQL' => 'mysql', 'MySQLi' => 'mysqli',
250 'PgSQL' => 'pgsql', 'SQLite' => 'sqlite');
252 $select_dbtype = new html_select(array('name' => '_dbtype', 'id' => "cfgdbtype"));
253 foreach ($supported_dbs AS $database => $ext) {
254 if (extension_loaded($ext)) {
255 $select_dbtype->add($database, $ext);
259 $input_dbhost = new html_inputfield(array('name' => '_dbhost', 'size' => 20, 'id' => "cfgdbhost"));
260 $input_dbname = new html_inputfield(array('name' => '_dbname', 'size' => 20, 'id' => "cfgdbname"));
261 $input_dbuser = new html_inputfield(array('name' => '_dbuser', 'size' => 20, 'id' => "cfgdbuser"));
262 $input_dbpass = new html_passwordfield(array('name' => '_dbpass', 'size' => 20, 'id' => "cfgdbpass"));
264 $dsnw = MDB2::parseDSN($RCI->getprop('db_dsnw'));
266 echo $select_dbtype->show($RCI->is_post ? $_POST['_dbtype'] : $dsnw['phptype']);
267 echo '<label for="cfgdbtype">Database type</label><br />';
268 echo $input_dbhost->show($RCI->is_post ? $_POST['_dbhost'] : $dsnw['hostspec']);
269 echo '<label for="cfgdbhost">Database server (omit for sqlite)</label><br />';
270 echo $input_dbname->show($RCI->is_post ? $_POST['_dbname'] : $dsnw['database']);
271 echo '<label for="cfgdbname">Database name (use absolute path and filename for sqlite)</label><br />';
272 echo $input_dbuser->show($RCI->is_post ? $_POST['_dbuser'] : $dsnw['username']);
273 echo '<label for="cfgdbuser">Database user name (needs write permissions)(omit for sqlite)</label><br />';
274 echo $input_dbpass->show($RCI->is_post ? $_POST['_dbpass'] : $dsnw['password']);
275 echo '<label for="cfgdbpass">Database password (omit for sqlite)</label><br />';
284 <legend>IMAP Settings</legend>
285 <dl class="configblock" id="cgfblockimap">
286 <dt class="propname">default_host</dt>
288 <div>The IMAP host(s) chosen to perform the log-in</div>
289 <div id="defaulthostlist">
292 $text_imaphost = new html_inputfield(array('name' => '_default_host[]', 'size' => 30));
293 $default_hosts = $RCI->get_hostlist();
295 if (empty($default_hosts))
296 $default_hosts = array('');
299 foreach ($default_hosts as $host) {
300 echo '<div id="defaulthostentry'.$i.'">' . $text_imaphost->show($host);
302 echo '<a href="#" onclick="removehostfield(this.parentNode);return false" class="removelink" title="Remove this entry">remove</a>';
308 <div><a href="javascript:addhostfield()" class="addlink" title="Add another field">add</a></div>
310 <p class="hint">Leave blank to show a textbox at login. To use SSL/IMAPS connection, type ssl://hostname</p>
313 <dt class="propname">default_port</dt>
317 $text_imapport = new html_inputfield(array('name' => '_default_port', 'size' => 6, 'id' => "cfgimapport"));
318 echo $text_imapport->show($RCI->getprop('default_port'));
321 <div>TCP port used for IMAP connections</div>
324 <dt class="propname">username_domain</dt>
328 $text_userdomain = new html_inputfield(array('name' => '_username_domain', 'size' => 30, 'id' => "cfguserdomain"));
329 echo $text_userdomain->show($RCI->getprop('username_domain'));
332 <div>Automatically add this domain to user names for login</div>
334 <p class="hint">Only for IMAP servers that require full e-mail addresses for login</p>
337 <dt class="propname">auto_create_user</dt>
341 $check_autocreate = new html_checkbox(array('name' => '_auto_create_user', 'id' => "cfgautocreate"));
342 echo $check_autocreate->show(intval($RCI->getprop('auto_create_user')), array('value' => 1));
345 <label for="cfgautocreate">Automatically create a new Roundcube user when log-in the first time</label><br />
347 <p class="hint">A user is authenticated by the IMAP server but it requires a local record to store settings
348 and contacts. With this option enabled a new user record will automatically be created once the IMAP login succeeds.</p>
350 <p class="hint">If this option is disabled, the login only succeeds if there's a matching user-record in the local Roundcube database
351 what means that you have to create those records manually or disable this option after the first login.</p>
354 <dt class="propname">sent_mbox</dt>
358 $text_sentmbox = new html_inputfield(array('name' => '_sent_mbox', 'size' => 20, 'id' => "cfgsentmbox"));
359 echo $text_sentmbox->show($RCI->getprop('sent_mbox'));
362 <div>Store sent messages in this folder</div>
364 <p class="hint">Leave blank if sent messages should not be stored. Note: folder must include namespace prefix if any.</p>
367 <dt class="propname">trash_mbox</dt>
371 $text_trashmbox = new html_inputfield(array('name' => '_trash_mbox', 'size' => 20, 'id' => "cfgtrashmbox"));
372 echo $text_trashmbox->show($RCI->getprop('trash_mbox'));
375 <div>Move messages to this folder when deleting them</div>
377 <p class="hint">Leave blank if they should be deleted directly. Note: folder must include namespace prefix if any.</p>
380 <dt class="propname">drafts_mbox</dt>
384 $text_draftsmbox = new html_inputfield(array('name' => '_drafts_mbox', 'size' => 20, 'id' => "cfgdraftsmbox"));
385 echo $text_draftsmbox->show($RCI->getprop('drafts_mbox'));
388 <div>Store draft messages in this folder</div>
390 <p class="hint">Leave blank if they should not be stored. Note: folder must include namespace prefix if any.</p>
393 <dt class="propname">junk_mbox</dt>
397 $text_junkmbox = new html_inputfield(array('name' => '_junk_mbox', 'size' => 20, 'id' => "cfgjunkmbox"));
398 echo $text_junkmbox->show($RCI->getprop('junk_mbox'));
401 <div>Store spam messages in this folder</div>
403 <p class="hint">Note: folder must include namespace prefix if any.</p>
412 <legend>SMTP Settings</legend>
413 <dl class="configblock" id="cgfblocksmtp">
414 <dt class="propname">smtp_server</dt>
418 $text_smtphost = new html_inputfield(array('name' => '_smtp_server', 'size' => 30, 'id' => "cfgsmtphost"));
419 echo $text_smtphost->show($RCI->getprop('smtp_server'));
422 <div>Use this host for sending mails</div>
424 <p class="hint">To use SSL connection, set ssl://smtp.host.com. If left blank, the PHP mail() function is used</p>
427 <dt class="propname">smtp_port</dt>
431 $text_smtpport = new html_inputfield(array('name' => '_smtp_port', 'size' => 6, 'id' => "cfgsmtpport"));
432 echo $text_smtpport->show($RCI->getprop('smtp_port'));
435 <div>SMTP port (default is 25; 465 for SSL; 587 for submission)</div>
438 <dt class="propname">smtp_user/smtp_pass</dt>
442 $text_smtpuser = new html_inputfield(array('name' => '_smtp_user', 'size' => 20, 'id' => "cfgsmtpuser"));
443 $text_smtppass = new html_passwordfield(array('name' => '_smtp_pass', 'size' => 20, 'id' => "cfgsmtppass"));
444 echo $text_smtpuser->show($RCI->getprop('smtp_user'));
445 echo $text_smtppass->show($RCI->getprop('smtp_pass'));
448 <div>SMTP username and password (if required)</div>
452 $check_smtpuser = new html_checkbox(array('name' => '_smtp_user_u', 'id' => "cfgsmtpuseru"));
453 echo $check_smtpuser->show($RCI->getprop('smtp_user') == '%u' || $_POST['_smtp_user_u'] ? 1 : 0, array('value' => 1));
456 <label for="cfgsmtpuseru">Use the current IMAP username and password for SMTP authentication</label>
460 <dt class="propname">smtp_auth_type</dt>
464 $select_smtpauth = new html_select(array('name' => '_smtp_auth_type', 'id' => "cfgsmtpauth"));
465 $select_smtpauth->add(array('(auto)', 'PLAIN', 'DIGEST-MD5', 'CRAM-MD5', 'LOGIN'), array('0', 'PLAIN', 'DIGEST-MD5', 'CRAM-MD5', 'LOGIN'));
466 echo $select_smtpauth->show(intval($RCI->getprop('smtp_auth_type')));
469 <div>Method to authenticate at the SMTP server. Choose (auto) if you don't know what this is</div>
472 <dt class="propname">smtp_log</dt>
476 $check_smtplog = new html_checkbox(array('name' => '_smtp_log', 'id' => "cfgsmtplog"));
477 echo $check_smtplog->show(intval($RCI->getprop('smtp_log')), array('value' => 1));
480 <label for="cfgsmtplog">Log sent messages in <tt>{log_dir}/sendmail</tt> or to syslog.</label><br />
488 <legend>Display settings & user prefs</legend>
489 <dl class="configblock" id="cgfblockdisplay">
491 <dt class="propname">language <span class="userconf">*</span></dt>
495 $input_locale = new html_inputfield(array('name' => '_language', 'size' => 6, 'id' => "cfglocale"));
496 echo $input_locale->show($RCI->getprop('language'));
499 <div>The default locale setting. This also defines the language of the login screen.<br/>Leave it empty to auto-detect the user agent language.</div>
500 <p class="hint">Enter a <a href="http://www.faqs.org/rfcs/rfc1766">RFC1766</a> formatted language name. Examples: en_US, de_DE, de_CH, fr_FR, pt_BR</p>
503 <dt class="propname">skin <span class="userconf">*</span></dt>
507 $input_skin = new html_select(array('name' => '_skin', 'id' => "cfgskin"));
508 $input_skin->add($RCI->list_skins());
509 echo $input_skin->show($RCI->getprop('skin'));
512 <div>Name of interface skin (folder in /skins)</div>
515 <dt class="propname">skin_logo</dt>
519 $input_skin = new html_inputfield(array('name' => '_skin_logo', 'size' => 50, 'id' => "cfgskinlogo"));
520 echo $input_skin->show($RCI->getprop('skin_logo'));
523 <div>Custom image to display instead of the Roundcube logo.</div>
524 <p class="hint">Enter a URL relative to the document root of this Roundcube installation.</p>
527 <dt class="propname">pagesize <span class="userconf">*</span></dt>
531 $input_pagesize = new html_inputfield(array('name' => '_pagesize', 'size' => 6, 'id' => "cfgpagesize"));
532 echo $input_pagesize->show($RCI->getprop('pagesize'));
535 <div>Show up to X items in list view.</div>
538 <dt class="propname">prefer_html <span class="userconf">*</span></dt>
542 $check_htmlview = new html_checkbox(array('name' => '_prefer_html', 'id' => "cfghtmlview", 'value' => 1));
543 echo $check_htmlview->show(intval($RCI->getprop('prefer_html')));
546 <label for="cfghtmlview">Prefer displaying HTML messages</label><br />
549 <dt class="propname">preview_pane <span class="userconf">*</span></dt>
553 $check_prevpane = new html_checkbox(array('name' => '_preview_pane', 'id' => "cfgprevpane", 'value' => 1));
554 echo $check_prevpane->show(intval($RCI->getprop('preview_pane')));
557 <label for="cfgprevpane">If preview pane is enabled</label><br />
560 <dt class="propname">htmleditor <span class="userconf">*</span></dt>
562 <label for="cfghtmlcompose">Compose HTML formatted messages</label>
565 $select_htmlcomp = new html_select(array('name' => '_htmleditor', 'id' => "cfghtmlcompose"));
566 $select_htmlcomp->add('never', 0);
567 $select_htmlcomp->add('always', 1);
568 $select_htmlcomp->add('on reply to HTML message only', 2);
569 echo $select_htmlcomp->show(intval($RCI->getprop('htmleditor')));
574 <dt class="propname">draft_autosave <span class="userconf">*</span></dt>
576 <label for="cfgautosave">Save compose message every</label>
579 $select_autosave = new html_select(array('name' => '_draft_autosave', 'id' => 'cfgautosave'));
580 $select_autosave->add('never', 0);
581 foreach (array(1, 3, 5, 10) as $i => $min)
582 $select_autosave->add("$min min", $min*60);
584 echo $select_autosave->show(intval($RCI->getprop('draft_autosave')));
589 <dt class="propname">mdn_requests <span class="userconf">*</span></dt>
595 1 => 'send automatically',
596 3 => 'send receipt to user contacts, otherwise ask the user',
597 4 => 'send receipt to user contacts, otherwise ignore',
601 $select_mdnreq = new html_select(array('name' => '_mdn_requests', 'id' => "cfgmdnreq"));
602 $select_mdnreq->add(array_values($mdn_opts), array_keys($mdn_opts));
603 echo $select_mdnreq->show(intval($RCI->getprop('mdn_requests')));
606 <div>Behavior if a received message requests a message delivery notification (read receipt)</div>
609 <dt class="propname">mime_param_folding <span class="userconf">*</span></dt>
613 $select_param_folding = new html_select(array('name' => '_mime_param_folding', 'id' => "cfgmimeparamfolding"));
614 $select_param_folding->add('Full RFC 2231 (Roundcube, Thunderbird)', '0');
615 $select_param_folding->add('RFC 2047/2231 (MS Outlook, OE)', '1');
616 $select_param_folding->add('Full RFC 2047 (deprecated)', '2');
618 echo $select_param_folding->show(intval($RCI->getprop('mime_param_folding')));
621 <div>How to encode attachment long/non-ascii names</div>
626 <p class="hint"><span class="userconf">*</span> These settings are defaults for the user preferences</p>
631 echo '<p><input type="submit" name="submit" value="' . ($RCI->configured ? 'UPDATE' : 'CREATE') . ' CONFIG" ' . ($RCI->failures ? 'disabled' : '') . ' /></p>';