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->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>config/</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($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($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 id="cgfblockgeneral" class="propname">debug_level</dt>
55 $value = $RCI->getprop('debug_level');
56 $check_debug = new html_checkbox(array('name' => '_debug_level[]'));
57 echo $check_debug->show(($value & 1) ? 1 : 0 , array('value' => 1, 'id' => 'cfgdebug1'));
58 echo '<label for="cfgdebug1">Log errors</label><br />';
60 echo $check_debug->show(($value & 4) ? 4 : 0, array('value' => 4, 'id' => 'cfgdebug4'));
61 echo '<label for="cfgdebug4">Display errors</label><br />';
63 echo $check_debug->show(($value & 8) ? 8 : 0, array('value' => 8, 'id' => 'cfgdebug8'));
64 echo '<label for="cfgdebug8">Verbose display</label><br />';
70 <dt class="propname">product_name</dt>
74 $input_prodname = new html_inputfield(array('name' => '_product_name', 'size' => 30, 'id' => "cfgprodname"));
75 echo $input_prodname->show($RCI->getprop('product_name'));
78 <div>The name of your service (used to compose page titles)</div>
81 <dt class="propname">skin_path</dt>
85 $input_skinpath = new html_inputfield(array('name' => '_skin_path', 'size' => 30, 'id' => "cfgskinpath"));
86 echo $input_skinpath->show($RCI->getprop('skin_path'));
89 <div>Relative path to the skin folder</div>
92 <dt class="propname">temp_dir</dt>
96 $input_tempdir = new html_inputfield(array('name' => '_temp_dir', 'size' => 30, 'id' => "cfgtempdir"));
97 echo $input_tempdir->show($RCI->getprop('temp_dir'));
100 <div>Use this folder to store temp files (must be writebale for webserver)</div>
103 <dt class="propname">log_dir</dt>
107 $input_logdir = new html_inputfield(array('name' => '_log_dir', 'size' => 30, 'id' => "cfglogdir"));
108 echo $input_logdir->show($RCI->getprop('log_dir'));
111 <div>Use this folder to store log files (must be writebale for webserver)</div>
114 <dt class="propname">ip_check</dt>
118 $check_ipcheck = new html_checkbox(array('name' => '_ip_check', 'id' => "cfgipcheck"));
119 echo $check_ipcheck->show(intval($RCI->getprop('ip_check')), array('value' => 1));
122 <label for="cfgipcheck">Check client IP in session authorization</label><br />
124 <p class="hint">This increases security but can cause sudden logouts when someone uses a proxy with changeing IPs.</p>
127 <dt class="propname">des_key</dt>
131 $input_deskey = new html_inputfield(array('name' => '_des_key', 'size' => 30, 'id' => "cfgdeskey"));
132 echo $input_deskey->show($RCI->getprop('des_key'));
135 <div>This key is used to encrypt the users imap password before storing in the session record</div>
136 <p class="hint">It's a random generated string to ensure that every installation has it's own key.
137 If you enter it manually please provide a string of exactly 24 chars.</p>
140 <dt class="propname">enable_caching</dt>
144 $check_caching = new html_checkbox(array('name' => '_enable_caching', 'id' => "cfgcache"));
145 echo $check_caching->show(intval($RCI->getprop('enable_caching')), array('value' => 1));
148 <label for="cfgcache">Cache messages in local database</label><br />
151 <dt class="propname">enable_spellcheck</dt>
155 $check_caching = new html_checkbox(array('name' => '_enable_spellcheck', 'id' => "cfgspellcheck"));
156 echo $check_caching->show(intval($RCI->getprop('enable_spellcheck')), array('value' => 1));
159 <label for="cfgspellcheck">Make use of the built-in spell checker</label><br />
161 <p class="hint">It is based on GoogieSpell what implies that the message content will be sent to Google in order to check the spelling.</p>
164 <dt class="propname">mdn_requests</dt>
168 $select_mdnreq = new html_select(array('name' => '_mdn_requests', 'id' => "cfgmdnreq"));
169 $select_mdnreq->add(array('ask the user', 'send automatically', 'ignore'), array(0, 1, 2));
170 echo $select_mdnreq->show(intval($RCI->getprop('mdn_requests')));
173 <div>Behavior if a received message requests a message delivery notification (read receipt)</div>
180 <legend>Database setup</legend>
181 <dl class="configblock" id="cgfblockdb">
182 <dt class="propname">db_dsnw</dt>
184 <p>Database settings for read/write operations:</p>
187 require_once 'MDB2.php';
189 $supported_dbs = array('MySQL' => 'mysql', 'MySQLi' => 'mysqli',
190 'PgSQL' => 'pgsql', 'SQLite' => 'sqlite');
192 $select_dbtype = new html_select(array('name' => '_dbtype', 'id' => "cfgdbtype"));
193 foreach ($supported_dbs AS $database => $ext) {
194 if (extension_loaded($ext)) {
195 $select_dbtype->add($database, $ext);
199 $input_dbhost = new html_inputfield(array('name' => '_dbhost', 'size' => 20, 'id' => "cfgdbhost"));
200 $input_dbname = new html_inputfield(array('name' => '_dbname', 'size' => 20, 'id' => "cfgdbname"));
201 $input_dbuser = new html_inputfield(array('name' => '_dbuser', 'size' => 20, 'id' => "cfgdbuser"));
202 $input_dbpass = new html_passwordfield(array('name' => '_dbpass', 'size' => 20, 'id' => "cfgdbpass"));
204 $dsnw = MDB2::parseDSN($RCI->getprop('db_dsnw'));
206 echo $select_dbtype->show($RCI->is_post ? $_POST['_dbtype'] : $dsnw['phptype']);
207 echo '<label for="cfgdbtype">Database type</label><br />';
208 echo $input_dbhost->show($RCI->is_post ? $_POST['_dbhost'] : $dsnw['hostspec']);
209 echo '<label for="cfgdbhost">Database server</label><br />';
210 echo $input_dbname->show($RCI->is_post ? $_POST['_dbname'] : $dsnw['database']);
211 echo '<label for="cfgdbname">Database name</label><br />';
212 echo $input_dbuser->show($RCI->is_post ? $_POST['_dbuser'] : $dsnw['username']);
213 echo '<label for="cfgdbuser">Database user name (needs write permissions)</label><br />';
214 echo $input_dbpass->show($RCI->is_post ? $_POST['_dbpass'] : $dsnw['password']);
215 echo '<label for="cfgdbpass">Database password</label><br />';
220 <dt class="propname">db_backend</dt>
224 // check for existing PEAR classes
225 @include_once 'DB.php';
226 @include_once 'MDB2.php';
228 $select_dbba = new html_select(array('name' => '_db_backend', 'id' => "cfgdbba"));
230 if (class_exists('DB'))
231 $select_dbba->add('DB', 'db');
232 if (class_exists('MDB2'))
233 $select_dbba->add('MDB2', 'mdb2');
235 echo $select_dbba->show($RCI->getprop('db_backend'));
238 <div>PEAR Database backend to use</div>
246 <legend>IMAP Settings</legend>
247 <dl class="configblock" id="cgfblockimap">
248 <dt class="propname">default_host</dt>
250 <div>The IMAP host(s) chosen to perform the log-in</div>
251 <div id="defaulthostlist">
254 $text_imaphost = new html_inputfield(array('name' => '_default_host[]', 'size' => 30));
255 $default_hosts = $RCI->get_hostlist();
257 if (empty($default_hosts))
258 $default_hosts = array('');
261 foreach ($default_hosts as $host) {
262 echo '<div id="defaulthostentry'.$i.'">' . $text_imaphost->show($host);
264 echo '<a href="#" onclick="removehostfield(this.parentNode);return false" class="removelink" title="Remove this entry">remove</a>';
270 <div><a href="javascript:addhostfield()" class="addlink" title="Add another field">add</a></div>
272 <p class="hint">Leave blank to show a textbox at login. To use SSL/IMAPS connection, type ssl://hostname</p>
275 <dt class="propname">default_port</dt>
279 $text_imapport = new html_inputfield(array('name' => '_default_port', 'size' => 6, 'id' => "cfgimapport"));
280 echo $text_imapport->show($RCI->getprop('default_port'));
283 <div>TCP port used for IMAP connections</div>
286 <dt class="propname">username_domain</dt>
290 $text_userdomain = new html_inputfield(array('name' => '_username_domain', 'size' => 30, 'id' => "cfguserdomain"));
291 echo $text_userdomain->show($RCI->getprop('username_domain'));
294 <div>Automatically add this domain to user names for login</div>
296 <p class="hint">Only for IMAP servers that require full e-mail addresses for login</p>
299 <dt class="propname">auto_create_user</dt>
303 $check_autocreate = new html_checkbox(array('name' => '_auto_create_user', 'id' => "cfgautocreate"));
304 echo $check_autocreate->show(intval($RCI->getprop('auto_create_user')), array('value' => 1));
307 <label for="cfgautocreate">Automatically create a new RoundCube user when log-in the first time</label><br />
309 <p class="hint">A user is authenticated by the IMAP server but it requires a local record to store settings
310 and contacts. With this option enabled a new user record will automatically be created once the IMAP login succeeds.</p>
312 <p class="hint">If this option is disabled, the login only succeeds if there's a matching user-record in the local RoundCube database
313 what means that you have to create those records manually or disable this option after the first login.</p>
316 <dt class="propname">sent_mbox</dt>
320 $text_sentmbox = new html_inputfield(array('name' => '_sent_mbox', 'size' => 20, 'id' => "cfgsentmbox"));
321 echo $text_sentmbox->show($RCI->getprop('sent_mbox'));
324 <div>Store sent messages is this folder</div>
326 <p class="hint">Leave blank if sent messages should not be stored</p>
329 <dt class="propname">trash_mbox</dt>
333 $text_trashmbox = new html_inputfield(array('name' => '_trash_mbox', 'size' => 20, 'id' => "cfgtrashmbox"));
334 echo $text_trashmbox->show($RCI->getprop('trash_mbox'));
337 <div>Move messages to this folder when deleting them</div>
339 <p class="hint">Leave blank if they should be deleted directly</p>
342 <dt class="propname">drafts_mbox</dt>
346 $text_draftsmbox = new html_inputfield(array('name' => '_drafts_mbox', 'size' => 20, 'id' => "cfgdraftsmbox"));
347 echo $text_draftsmbox->show($RCI->getprop('drafts_mbox'));
350 <div>Store draft messages is this folder</div>
358 <legend>SMTP Settings</legend>
359 <dl class="configblock" id="cgfblocksmtp">
360 <dt class="propname">smtp_server</dt>
364 $text_smtphost = new html_inputfield(array('name' => '_smtp_server', 'size' => 30, 'id' => "cfgsmtphost"));
365 echo $text_smtphost->show($RCI->getprop('smtp_server'));
368 <div>Use this host for sending mails</div>
370 <p class="hint">To use SSL connection, set ssl://smtp.host.com. If left blank, the PHP mail() function is used</p>
373 <dt class="propname">smtp_port</dt>
377 $text_smtpport = new html_inputfield(array('name' => '_smtp_port', 'size' => 6, 'id' => "cfgsmtpport"));
378 echo $text_smtpport->show($RCI->getprop('smtp_port'));
381 <div>SMTP port (default is 25; 465 for SSL)</div>
384 <dt class="propname">smtp_user/smtp_pass</dt>
388 $text_smtpuser = new html_inputfield(array('name' => '_smtp_user', 'size' => 20, 'id' => "cfgsmtpuser"));
389 $text_smtppass = new html_passwordfield(array('name' => '_smtp_pass', 'size' => 20, 'id' => "cfgsmtppass"));
390 echo $text_smtpuser->show($RCI->getprop('smtp_user'));
391 echo $text_smtppass->show($RCI->getprop('smtp_pass'));
394 <div>SMTP username and password (if required)</div>
398 $check_smtpuser = new html_checkbox(array('name' => '_smtp_user_u', 'id' => "cfgsmtpuseru"));
399 echo $check_smtpuser->show($RCI->getprop('smtp_user') == '%u' || $_POST['_smtp_user_u'] ? 1 : 0, array('value' => 1));
402 <label for="cfgsmtpuseru">Use the current IMAP username and password for SMTP authentication</label>
406 <dt class="propname">smtp_auth_type</dt>
410 $select_smtpauth = new html_select(array('name' => '_smtp_auth_type', 'id' => "cfgsmtpauth"));
411 $select_smtpauth->add(array('(auto)', 'PLAIN', 'DIGEST-MD5', 'CRAM-MD5', 'LOGIN'), array('0', 'PLAIN', 'DIGEST-MD5', 'CRAM-MD5', 'LOGIN'));
412 echo $select_smtpauth->show(intval($RCI->getprop('smtp_auth_type')));
415 <div>Method to authenticate at the SMTP server. Choose (auto) if you don't know what this is</div>
418 <dt class="propname">smtp_log</dt>
422 $check_smtplog = new html_checkbox(array('name' => '_smtp_log', 'id' => "cfgsmtplog"));
423 echo $check_smtplog->show(intval($RCI->getprop('smtp_log')), array('value' => 1));
426 <label for="cfgsmtplog">Log sent messages in <tt>logs/sendmail</tt></label><br />
434 <legend>Display settings & user prefs</legend>
435 <dl class="configblock" id="cgfblockdisplay">
437 <dt class="propname">locale_string</dt>
441 $input_locale = new html_inputfield(array('name' => '_locale_string', 'size' => 6, 'id' => "cfglocale"));
442 echo $input_locale->show($RCI->getprop('locale_string'));
445 <div>The default locale setting. This also defines the language of the login screen.</div>
446 <p class="hint">Enter a <a href="http://www.faqs.org/rfcs/rfc1766">RFC1766</a> formatted locale name. Examples: en_US, de, de_CH, fr, pt_BR</p>
449 <dt class="propname">pagesize <span class="userconf">*</span></dt>
453 $input_pagesize = new html_inputfield(array('name' => '_pagesize', 'size' => 6, 'id' => "cfgpagesize"));
454 echo $input_pagesize->show($RCI->getprop('pagesize'));
457 <div>Show up to X items in list view.</div>
460 <dt class="propname">prefer_html <span class="userconf">*</span></dt>
464 $check_htmlview = new html_checkbox(array('name' => '_prefer_html', 'id' => "cfghtmlview", 'value' => 1));
465 echo $check_htmlview->show(intval($RCI->getprop('prefer_html')));
468 <label for="cfghtmlview">Prefer displaying HTML messages</label><br />
471 <dt class="propname">preview_pane <span class="userconf">*</span></dt>
475 $check_prevpane = new html_checkbox(array('name' => '_preview_pane', 'id' => "cfgprevpane", 'value' => 1));
476 echo $check_prevpane->show(intval($RCI->getprop('preview_pane')));
479 <label for="cfgprevpane">If preview pane is enabled</label><br />
482 <dt class="propname">htmleditor <span class="userconf">*</span></dt>
486 $check_htmlcomp = new html_checkbox(array('name' => '_htmleditor', 'id' => "cfghtmlcompose", 'value' => 1));
487 echo $check_htmlcomp->show(intval($RCI->getprop('htmleditor')));
490 <label for="cfghtmlcompose">Compose HTML formatted messages</label><br />
493 <dt class="propname">draft_autosave <span class="userconf">*</span></dt>
495 <label for="cfgautosave">Save compose message every</label>
498 $select_autosave = new html_select(array('name' => '_draft_autosave', 'id' => 'cfgautosave'));
499 $select_autosave->add('never', 0);
500 foreach (array(3, 5, 10) as $i => $min)
501 $select_autosave->add("$min min", $min*60);
503 echo $select_autosave->show(intval($RCI->getprop('draft_autosave')));
510 <p class="hint"><span class="userconf">*</span> These settings are defaults for the user preferences</p>
515 echo '<p><input type="submit" name="submit" value="' . ($RCI->configured ? 'UPDATE' : 'CREATE') . ' CONFIG" ' . ($RCI->failures ? 'disabled' : '') . ' /></p>';