diff --git a/source/about/roundcubemail-plugin-threading_as_default/building.rst b/source/about/roundcubemail-plugin-threading_as_default/building.rst deleted file mode 100644 index 24ab7a5e..00000000 --- a/source/about/roundcubemail-plugin-threading_as_default/building.rst +++ /dev/null @@ -1,2 +0,0 @@ -Building -======== diff --git a/source/about/roundcubemail-plugin-threading_as_default/contributing.rst b/source/about/roundcubemail-plugin-threading_as_default/contributing.rst deleted file mode 100644 index 5a1988f1..00000000 --- a/source/about/roundcubemail-plugin-threading_as_default/contributing.rst +++ /dev/null @@ -1,2 +0,0 @@ -Contributing -============ diff --git a/source/about/roundcubemail-plugin-threading_as_default/index.rst b/source/about/roundcubemail-plugin-threading_as_default/index.rst deleted file mode 100644 index 563f083e..00000000 --- a/source/about/roundcubemail-plugin-threading_as_default/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _about-roundcubemail-plugin-threading_as_default: - -========================================= -roundcubemail-plugin-threading_as_default -========================================= - -.. toctree:: - :maxdepth: 1 - :glob: - - * diff --git a/source/about/roundcubemail-plugin-threading_as_default/installation.rst b/source/about/roundcubemail-plugin-threading_as_default/installation.rst deleted file mode 100644 index 11e44375..00000000 --- a/source/about/roundcubemail-plugin-threading_as_default/installation.rst +++ /dev/null @@ -1,2 +0,0 @@ -Installation -============ diff --git a/source/about/roundcubemail-plugin-threading_as_default/packaging.rst b/source/about/roundcubemail-plugin-threading_as_default/packaging.rst deleted file mode 100644 index 921e0149..00000000 --- a/source/about/roundcubemail-plugin-threading_as_default/packaging.rst +++ /dev/null @@ -1,2 +0,0 @@ -Packaging -========= diff --git a/source/about/roundcubemail-plugin-threading_as_default/troubleshooting.rst b/source/about/roundcubemail-plugin-threading_as_default/troubleshooting.rst deleted file mode 100644 index 4edddddf..00000000 --- a/source/about/roundcubemail-plugin-threading_as_default/troubleshooting.rst +++ /dev/null @@ -1,2 +0,0 @@ -Troubleshooting -=============== diff --git a/source/about/roundcubemail-plugin-threading_as_default/version-matrix.rst b/source/about/roundcubemail-plugin-threading_as_default/version-matrix.rst deleted file mode 100644 index 73c7668a..00000000 --- a/source/about/roundcubemail-plugin-threading_as_default/version-matrix.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _about-roundcubemail-plugin-threading_as_default-version-matrix: - -Version Matrix -============== - -.. table:: Version Table for roundcubemail-plugin-threading_as_default - - +---------------------+---------------+--------------------------------------+ - | Kolab Version(s) | Platform(s) | Version | - +=====================+===============+======================================+ - | Kolab:13 | CentOS_6 | 0.9-3 | - +---------------------+---------------+--------------------------------------+ - | | Ubuntu_14.04 | 0.9-3 | - +---------------------+---------------+--------------------------------------+ diff --git a/source/administrator-guide/roundcube-settings-reference.rst b/source/administrator-guide/roundcube-settings-reference.rst index 6837a985..88103cf8 100644 --- a/source/administrator-guide/roundcube-settings-reference.rst +++ b/source/administrator-guide/roundcube-settings-reference.rst @@ -1,441 +1,450 @@ .. _admin_roundcube-settings: ================================== Roundcube Settings Reference Guide ================================== Roundcube is configured using a default settings file, a settings file for site-specific configuration, host-specific configuration files, and configuration files specific to plugins. The configuration inheritance model looks as follows: ``config/defaults.inc.php`` This configuration file ships the default settings for Roundcube. .. NOTE:: On the expanded sources (from tarball releases), this file is at :file:`your/install/path/config/defaults.inc.php`. On packaged distributions however, this path is a symbolic link to :file:`/etc/roundcubemail/defaults.inc.php`. ``config/config.inc.php`` Site-specific global settings are in this configuration file. .. NOTE:: On the expanded sources (from tarball releases), this file starts out as :file:`your/install/path/config/config.inc.php.dist`. You would rename this original ``.dist`` file to :file:`your/install/path/config/config.inc.php`, but on packaged distributions, this is already done by the packaging. Similar to ``defaults.inc.php``, this configuration file also lives in :file:`/etc/roundcubemail/`, at :file:`/etc/roundcubemail/config.inc.php` to be precise, and a symbolic link is created from to original file location to this location. ``config/.inc.php`` ```` being a placeholder for an arbitrary site name, Roundcube allows the inclusion of additional configuration using the :ref:`admin_roundcube-settings_include_host_config` setting. This is, however, NOT the recommended solution. ``plugins//config.inc.php`` Each plugin that requires configuration ships a :file:`config.inc.php.dist`. As you may have suspected, these configuration files too are created symbolic links for, to :file:`/etc/roundcubemail/.inc.php`. Since the configuration files are PHP code that is being executed while the configuration loads, one might add include statements such that configured condititions load additional configuration files on top of the aforementioned four (types). For example, :file:`/etc/roundcubemail/config.inc.php` might have a segment to establish defaults at the start, then include a site specific configuration file: .. code-block:: php // Do test whether the file exists before requiring it. if (file_exists(dirname(__FILE__) . PATH_SEPARATOR . $_SERVER["HTTP_HOST"] . PATH_SEPARATOR . basename(__FILE__))) { require_once(dirname(__FILE__) . PATH_SEPARATOR . $_SERVER["HTTP_HOST"] . PATH_SEPARATOR . basename(__FILE__)); } and then re-apply mandatory defaults: .. code-block:: php $mandatory_plugins = Array( 'kolab_auth', # Applies globally required routines # including authentication, # authorization and canonification. 'kolab_folders', # Hides groupware folders if the # plugins for them are not loaded. ); foreach ( $mandatory_plugins as $num => $plugin ) { if (!in_array($plugin, $config['plugins'])) { $config['plugins'][] = $plugin; } } ----------------- Database Settings ----------------- .. seealso:: * :ref:`admin_roundcube-settings_database-configuration-hints` .. include:: roundcube-settings/db_dsnr.txt .. include:: roundcube-settings/db_dsnw.txt .. include:: roundcube-settings/db_dsnw_noread.txt .. include:: roundcube-settings/db_persistent.txt .. include:: roundcube-settings/db_prefix.txt .. include:: roundcube-settings/db_table_dsn.txt .. seealso:: For more database related settings, see also: * :ref:`admin_roundcube-settings_imap_cache` * :ref:`admin_roundcube-settings_ldap_cache` * :ref:`admin_roundcube-settings_messages_cache` * :ref:`admin_roundcube-settings_session_storage` ------------- IMAP Settings ------------- .. include:: roundcube-settings/imap_cache.txt .. include:: roundcube-settings/imap_cache_ttl.txt .. include:: roundcube-settings/messages_cache.txt .. include:: roundcube-settings/messages_cache_threshold.txt .. include:: roundcube-settings/messages_cache_ttl.txt .. include:: roundcube-settings/memcache_hosts.txt .. include:: roundcube-settings/delete_always.txt .. include:: roundcube-settings/delete_junk.txt .. include:: roundcube-settings/logout_expunge.txt .. include:: roundcube-settings/logout_purge.txt .. include:: roundcube-settings/flag_for_deletion.txt .. include:: roundcube-settings/create_default_folders.txt .. include:: roundcube-settings/default_folders.txt .. include:: roundcube-settings/junk_mbox.txt .. include:: roundcube-settings/protect_default_folders.txt .. include:: roundcube-settings/check_all_folders.txt .. include:: roundcube-settings/default_host.txt .. include:: roundcube-settings/default_port.txt .. include:: roundcube-settings/imap_auth_cid.txt .. include:: roundcube-settings/imap_auth_pw.txt .. include:: roundcube-settings/imap_auth_type.txt .. include:: roundcube-settings/imap_delimiter.txt .. include:: roundcube-settings/imap_disabled_caps.txt .. include:: roundcube-settings/imap_force_caps.txt .. include:: roundcube-settings/imap_force_lsub.txt .. include:: roundcube-settings/imap_force_ns.txt .. include:: roundcube-settings/imap_ns_other.txt .. include:: roundcube-settings/imap_ns_personal.txt .. include:: roundcube-settings/imap_ns_shared.txt .. include:: roundcube-settings/imap_timeout.txt .. include:: roundcube-settings/min_refresh_interval.txt .. include:: roundcube-settings/no_save_sent_messages.txt .. include:: roundcube-settings/quota_zero_as_unlimited.txt .. include:: roundcube-settings/refresh_interval.txt .. include:: roundcube-settings/sent_mbox.txt .. include:: roundcube-settings/skip_deleted.txt .. include:: roundcube-settings/trash_mbox.txt ------------- LDAP Settings ------------- .. include:: roundcube-settings/ldap_public.txt .. include:: roundcube-settings/ldap_cache.txt .. include:: roundcube-settings/ldap_cache_ttl.txt .. include:: roundcube-settings/autocomplete_addressbooks.txt ----------------------------- Session & Login Configuration ----------------------------- .. include:: roundcube-settings/assets_path.txt .. include:: roundcube-settings/ip_check.txt .. include:: roundcube-settings/login_autocomplete.txt .. include:: roundcube-settings/login_lc.txt .. include:: roundcube-settings/log_logins.txt .. include:: roundcube-settings/log_session.txt .. include:: roundcube-settings/session_auth_name.txt .. include:: roundcube-settings/session_domain.txt .. include:: roundcube-settings/session_lifetime.txt .. include:: roundcube-settings/session_name.txt .. include:: roundcube-settings/session_path.txt .. include:: roundcube-settings/session_storage.txt .. include:: roundcube-settings/user_aliases.txt .. include:: roundcube-settings/mail_domain.txt .. include:: roundcube-settings/referer_check.txt .. include:: roundcube-settings/use_secure_urls.txt .. include:: roundcube-settings/username_domain_forced.txt .. include:: roundcube-settings/username_domain.txt ------------ Log Settings ------------ .. include:: roundcube-settings/debug_level.txt .. include:: roundcube-settings/imap_debug.txt .. include:: roundcube-settings/ldap_debug.txt .. include:: roundcube-settings/log_date_format.txt .. include:: roundcube-settings/log_dir.txt .. include:: roundcube-settings/log_driver.txt .. include:: roundcube-settings/per_user_logging.txt .. include:: roundcube-settings/smtp_debug.txt .. include:: roundcube-settings/sql_debug.txt .. include:: roundcube-settings/syslog_facility.txt .. include:: roundcube-settings/syslog_id.txt -.. seealso:: - - * :ref:`admin_roundcube-settings-plugin_kolab_activesync_activesync_debug` - * :ref:`admin_roundcube-settings-plugin_kolab_activesync_activesync_user_log` - -------------- Other Settings -------------- .. include:: roundcube-settings/addressbook_name_listing.txt .. include:: roundcube-settings/addressbook_pagesize.txt .. include:: roundcube-settings/addressbook_search_mode.txt .. include:: roundcube-settings/addressbook_search_mods.txt .. include:: roundcube-settings/addressbook_sort_col.txt .. include:: roundcube-settings/address_book_type.txt .. include:: roundcube-settings/address_template.txt .. include:: roundcube-settings/advanced_prefs.txt .. include:: roundcube-settings/autocomplete_max.txt .. include:: roundcube-settings/autocomplete_min_length.txt .. include:: roundcube-settings/autocomplete_single.txt .. include:: roundcube-settings/autocomplete_threads.txt .. include:: roundcube-settings/auto_create_user.txt .. include:: roundcube-settings/autoexpand_threads.txt .. include:: roundcube-settings/client_mimetypes.txt .. include:: roundcube-settings/compose_extwin.txt .. include:: roundcube-settings/compose_responses_static.txt .. include:: roundcube-settings/contact_photo_size.txt .. include:: roundcube-settings/date_formats.txt .. include:: roundcube-settings/date_format.txt .. include:: roundcube-settings/date_long.txt .. include:: roundcube-settings/date_short.txt .. include:: roundcube-settings/default_addressbook.txt .. include:: roundcube-settings/default_charset.txt .. include:: roundcube-settings/default_font_size.txt .. include:: roundcube-settings/default_font.txt .. include:: roundcube-settings/des_key.txt .. include:: roundcube-settings/display_next.txt .. include:: roundcube-settings/display_version.txt .. include:: roundcube-settings/dont_override.txt .. include:: roundcube-settings/draft_autosave.txt .. include:: roundcube-settings/drafts_mbox.txt .. include:: roundcube-settings/dsn_default.txt .. include:: roundcube-settings/email_dns_check.txt .. include:: roundcube-settings/enable_installer.txt .. include:: roundcube-settings/enable_spellcheck.txt .. include:: roundcube-settings/force_7bit.txt .. include:: roundcube-settings/force_https.txt .. include:: roundcube-settings/forward_attachment.txt .. include:: roundcube-settings/generic_message_footer_html.txt .. include:: roundcube-settings/generic_message_footer.txt .. include:: roundcube-settings/htmleditor.txt .. include:: roundcube-settings/http_received_header_encrypt.txt .. include:: roundcube-settings/http_received_header.txt .. include:: roundcube-settings/identities_level.txt .. include:: roundcube-settings/image_thumbnail_size.txt .. include:: roundcube-settings/im_convert_path.txt .. include:: roundcube-settings/im_identify_path.txt .. include:: roundcube-settings/include_host_config.txt .. include:: roundcube-settings/inline_images.txt .. include:: roundcube-settings/language.txt .. include:: roundcube-settings/line_length.txt .. include:: roundcube-settings/list_cols.txt .. include:: roundcube-settings/mail_header_delimiter.txt .. include:: roundcube-settings/mail_pagesize.txt .. include:: roundcube-settings/max_group_members.txt .. include:: roundcube-settings/max_pagesize.txt .. include:: roundcube-settings/max_recipients.txt .. include:: roundcube-settings/mdn_default.txt .. include:: roundcube-settings/mdn_requests.txt .. include:: roundcube-settings/mdn_use_from.txt .. include:: roundcube-settings/message_extwin.txt .. include:: roundcube-settings/message_show_email.txt .. include:: roundcube-settings/message_sort_col.txt .. include:: roundcube-settings/message_sort_order.txt .. include:: roundcube-settings/mime_magic.txt .. include:: roundcube-settings/mime_param_folding.txt .. include:: roundcube-settings/mime_types.txt .. include:: roundcube-settings/password_charset.txt .. include:: roundcube-settings/plugins.txt .. include:: roundcube-settings/prefer_html.txt .. include:: roundcube-settings/prettydate.txt .. include:: roundcube-settings/preview_pane_mark_read.txt .. include:: roundcube-settings/preview_pane.txt .. include:: roundcube-settings/product_name.txt .. include:: roundcube-settings/read_when_deleted.txt .. include:: roundcube-settings/recipients_separator.txt .. include:: roundcube-settings/reply_all_mode.txt .. include:: roundcube-settings/reply_mode.txt .. include:: roundcube-settings/reply_same_folder.txt .. include:: roundcube-settings/search_mods.txt .. include:: roundcube-settings/send_format_flowed.txt .. include:: roundcube-settings/sendmail_delay.txt .. include:: roundcube-settings/show_images.txt .. include:: roundcube-settings/show_real_foldernames.txt .. include:: roundcube-settings/show_sig.txt .. include:: roundcube-settings/skin_include_php.txt .. include:: roundcube-settings/skin_logo.txt .. include:: roundcube-settings/skin.txt .. include:: roundcube-settings/smtp_auth_cid.txt .. include:: roundcube-settings/smtp_auth_pw.txt .. include:: roundcube-settings/smtp_auth_type.txt .. include:: roundcube-settings/smtp_conn_options.txt .. include:: roundcube-settings/smtp_helo_host.txt .. include:: roundcube-settings/smtp_log.txt .. include:: roundcube-settings/smtp_pass.txt .. include:: roundcube-settings/smtp_port.txt .. include:: roundcube-settings/smtp_server.txt .. include:: roundcube-settings/smtp_timeout.txt .. include:: roundcube-settings/smtp_user.txt .. include:: roundcube-settings/spellcheck_before_send.txt .. include:: roundcube-settings/spellcheck_dictionary.txt .. include:: roundcube-settings/spellcheck_engine.txt .. include:: roundcube-settings/spellcheck_ignore_caps.txt .. include:: roundcube-settings/spellcheck_ignore_nums.txt .. include:: roundcube-settings/spellcheck_ignore_syms.txt .. include:: roundcube-settings/spellcheck_languages.txt .. include:: roundcube-settings/spellcheck_uri.txt .. include:: roundcube-settings/standard_windows.txt .. include:: roundcube-settings/strip_existing_sig.txt .. include:: roundcube-settings/support_url.txt .. include:: roundcube-settings/temp_dir_ttl.txt .. include:: roundcube-settings/temp_dir.txt .. include:: roundcube-settings/time_formats.txt .. include:: roundcube-settings/time_format.txt .. include:: roundcube-settings/timezone.txt .. include:: roundcube-settings/undo_timeout.txt .. include:: roundcube-settings/upload_progress.txt .. include:: roundcube-settings/use_https.txt .. include:: roundcube-settings/useragent.txt .. include:: roundcube-settings/x_frame_options.txt --------------- Plugin Settings --------------- .. _admin_roundcube-settings-plugin_acl: The ``acl`` Plugin ================== .. _admin_roundcube-settings-plugin_archive: The ``archive`` Plugin ====================== .. _admin_roundcube-settings-plugin_calendar: The ``calendar`` Plugin ======================= .. include:: roundcube-settings/calendar.txt .. _admin_roundcube-settings-plugin_kolab_activesync: The ``kolab_activesync`` Plugin =============================== -.. include:: roundcube-settings/activesync_debug.txt -.. include:: roundcube-settings/activesync_user_log.txt +.. include:: roundcube-settings/kolab_activesync.txt .. _admin_roundcube-settings-plugin_kolab_auth: The ``kolab_auth`` Plugin ========================= .. include:: roundcube-settings/kolab_auth.txt .. _admin_roundcube-settings-plugin_kolab_addressbook: The ``kolab_addressbook`` Plugin ================================ +.. include:: roundcube-settings/kolab_addressbook.txt + .. _admin_roundcube-settings-plugin_kolab_config: The ``kolab_config`` Plugin =========================== +.. include:: roundcube-settings/kolab_config.txt + .. _admin_roundcube-settings-plugin_kolab_delegation: The ``kolab_delegation`` Plugin =============================== +.. include:: roundcube-settings/kolab_delegation.txt + .. _admin_roundcube-settings-plugin_kolab_files: The ``kolab_files`` Plugin ========================== +.. include:: roundcube-settings/kolab_files.txt + .. _admin_roundcube-settings-plugin_kolab_folders: The ``kolab_folders`` Plugin ============================ +.. include:: roundcube-settings/kolab_folders.txt + .. _admin_roundcube-settings-plugin_libkolab: The ``libkolab`` Plugin ======================= .. include:: roundcube-settings/kolab_cache.txt .. include:: roundcube-settings/kolab_messages_cache_bypass.txt .. include:: roundcube-settings/kolab_use_subscriptions.txt .. include:: roundcube-settings/libkolab.txt .. _admin_roundcube-settings-plugin_libcalendaring: The ``libcalendaring`` Plugin ============================= +.. include:: roundcube-settings/libcalendaring.txt + .. _admin_roundcube-settings-plugin_managesieve: The ``managesieve`` Plugin ========================== +.. include:: roundcube-settings/managesieve.txt + .. _admin_roundcube-settings-plugin_password: The ``password`` Plugin ======================= +.. include:: roundcube-settings/password.txt + .. _admin_roundcube-settings-plugin_redundant_attachments: The ``redundant_attachments`` Plugin ==================================== +.. include:: roundcube-settings/redundant_attachments.txt + .. _admin_roundcube-settings-plugin_tasklist: The ``tasklist`` Plugin ======================= -.. _admin_roundcube-settings-plugin_threading_as_default: - -The ``threading_as_default`` Plugin -=================================== +.. include:: roundcube-settings/tasklist.txt diff --git a/source/administrator-guide/roundcube-settings/activesync_debug.txt b/source/administrator-guide/roundcube-settings/activesync_debug.txt deleted file mode 100644 index 6a1a660a..00000000 --- a/source/administrator-guide/roundcube-settings/activesync_debug.txt +++ /dev/null @@ -1,6 +0,0 @@ -.. _admin_roundcube-settings-plugin_kolab_activesync_activesync_debug: - -``activesync_debug`` --------------------- - -Enables ActiveSync protocol debuging. diff --git a/source/administrator-guide/roundcube-settings/activesync_user_log.txt b/source/administrator-guide/roundcube-settings/activesync_user_log.txt deleted file mode 100644 index fa865296..00000000 --- a/source/administrator-guide/roundcube-settings/activesync_user_log.txt +++ /dev/null @@ -1,6 +0,0 @@ -.. _admin_roundcube-settings-plugin_kolab_activesync_activesync_user_log: - -``activesync_user_log`` ------------------------ - -Enables logging to a separate directory for every user/device. diff --git a/source/administrator-guide/roundcube-settings/calendar.txt b/source/administrator-guide/roundcube-settings/calendar.txt index 1c5d7860..55c16062 100644 --- a/source/administrator-guide/roundcube-settings/calendar.txt +++ b/source/administrator-guide/roundcube-settings/calendar.txt @@ -1,223 +1,223 @@ ``calendar_driver`` =================== Calendar backend type. Possible values: 'kolab' or 'database' ``calendar_caldav_url`` ======================= Base URL to build fully qualified URIs to access calendars via CALDAV. Primarily used in a Kolab environment where CalDAV access is provided by the iRony service. The following replacement variables are supported: ``%h`` Current HTTP host ``%u`` Current webmail user name ``%n`` Calendar name -``%i` +``%i`` Calendar UUID Example: .. code-block:: php $config['calendar_caldav_url'] = 'http://%h/iRony/calendars/%u/%i'; ``calendar_contact_birthdays`` ============================== Boolean. Enables a read-only birthdays calendar from the user's address book(s). ``calendar_allow_invite_shared`` ================================ Boolean. Allows users to invite/edit attendees for events in shared folders which were created/organized by others. ``calendar_allow_itip_uninvited`` ================================= Boolean. Allow users to accecpt iTip invitations who are no explicitly listed as an attendee in the invitation message. This can be the case if invitations are sent to mailing lists or alias email addresses. ``calendar_default_view`` ========================= Default view shown when entering the calendar screen. Possible values: 'agendaDay', 'agendaWeek', 'month', 'table'. ``calendar_default_alarm_type`` =============================== Undocumented. ``calendar_default_alarm_offset`` ================================= Undocumented. ``calendar_date_format_sets`` ============================= Undocumented. ``calendar_event_coloring`` =========================== Undocumented. ``calendar_agenda_range`` ========================= Undocumented. ``calendar_first_day`` ====================== Undocumented. ``calendar_first_hour`` ======================= Undocumented. ``calendar_timeslots`` ====================== Undocumented. ``calendar_time_indicator`` =========================== Undocumented. ``calendar_work_start`` ======================= Undocumented. ``calendar_work_end`` ===================== Undocumented. ``calendar_itip_after_action`` ============================== Undocumented. ``calendar_itip_smtp_server`` ============================= SMTP host to used for send iTip replies from the unauthenticated web view where external users can accept or decline invitations. Set to '' in order to use PHP's mail() function for email delivery. To override the SMTP port or connection method, provide a full URL like ``tls://somehost:587`` ``calendar_itip_smtp_user`` =========================== SMTP username used to send unauthenticated itip replies. Explicity set to '' for overriding the default configuration from ``smtp_user``. ``calendar_itip_smtp_pass`` =========================== SMTP password used to send unauthenticated itip replies. Explicity set to '' for overriding the default configuration from ``smtp_pass``. ``kolab_invitation_calendars`` ============================== Boolean. Show virtual calendars with pending or declined event invitations. This option only has an effect with the Kolab backend. ``calendar_resources_driver`` ============================= Driver to provide a directory for resource booking. Leave empty or commented out to disable resources support. 'ldap' is the only implementation and possible value yet. ``calendar_resources_directory`` ================================ LDAP directory configuration to find available resources for events. Specify a full LDAP directory as described for :ref:`admin_roundcube-settings_ldap_public`. Some special considerations apply for the LDAP filter and other properties: .. code-block:: php $config['calendar_resources_directory'] = array( (...snip...) 'base_dn' => 'ou=Resources,dc=example,dc=org', 'filter' => '(\|(objectclass=kolabgroupofuniquenames)(objectclass=kolabsharedfolder))', (...snip...) 'search_fields' => array('cn'), 'sort' => array('cn'), (...snip...) 'fieldmap' => array( // Internal => LDAP 'name' => 'cn', 'email' => 'mail', 'owner' => 'owner', 'description' => 'description', 'attributes' => 'kolabdescattribute', // "{ : }" 'members' => 'uniquemember', // these mappings are required for owner display 'phone' => 'telephoneNumber', 'mobile' => 'mobile', ), 'class_type_map' => array( // Mapping of object class to _type attribute 'kolabsharedfolder' => 'resource', 'groupofuniquenames' => 'collection', ), 'groups' => array( 'name_attr' => 'cn', // resource collections are detected as groups ), ); diff --git a/source/administrator-guide/roundcube-settings/kolab_activesync.txt b/source/administrator-guide/roundcube-settings/kolab_activesync.txt new file mode 100644 index 00000000..fa646408 --- /dev/null +++ b/source/administrator-guide/roundcube-settings/kolab_activesync.txt @@ -0,0 +1,4 @@ +``activesync_setup_url`` +======================== + +An URL of the page with Activesync clients configuration manual. Default: http://docs.kolab.org/client-configuration/; diff --git a/source/administrator-guide/roundcube-settings/kolab_addressbook.txt b/source/administrator-guide/roundcube-settings/kolab_addressbook.txt new file mode 100644 index 00000000..47c25418 --- /dev/null +++ b/source/administrator-guide/roundcube-settings/kolab_addressbook.txt @@ -0,0 +1,33 @@ +``kolab_addressbook_prio`` +========================== + +This option allows to set addressbooks priority or to disable some of them. Disabled addressbooks will be not shown in the UI. Default: ``0``. +Possible values: +``0`` - "Global address book(s) first". Use all address books, starting with the global (LDAP) +``1`` - "Personal address book(s) first". Use all address books, starting with the personal (Kolab) +``2`` - "Global address book(s) only". Use the global (LDAP) addressbook. Disable the personal. +``3`` - "Personal address book(s) only". Use the personal (Kolab) addressbook(s). Disable the global. + +``kolab_addressbook_carddav_url`` +================================= + +Base URL to build fully qualified URIs to access address books via CardDAV. By default not set. +The following replacement variables are supported: +``%h`` - Current HTTP host +``%u`` - Current webmail user name +``%n`` - Folder name +``%i`` - Folder UUID +Example: ``$config['kolab_addressbook_carddav_url'] = 'http://%h/iRony/addressbooks/%u/%i';``. + +``kolab_addressbook_carddav_ldap`` +================================== + +Name of LDAP addressbook (a key in ``ldap_public`` configuration array) for which the CardDAV URI will be displayed if ``kolab_addressbook_carddav_url`` is set. +Use it when iRony's ``kolabdav_ldap_directory`` is enabled. Note that ``kolab_addressbook_carddav_url`` must use ``%i`` and not ``%n``. + + .. WARNING:: + There are limitations with volume and performance: + - CardDAV does a full sync of the entire contact resource. For LDAP this means that all entries matching the base_dn/filter are synced to every client. + It's thus only recommended for small setups with a couple hundred LDAP entries. + - Other than that, the ldap-directory exposed in iRony is strictly read-only. + Although correctly stated in the CardDAV properties, some clients (e.g. the Thunderbird SoGO connector) ignore these properties and allow modifications which then result in sync errors because the server denies such updates. diff --git a/source/administrator-guide/roundcube-settings/kolab_config.txt b/source/administrator-guide/roundcube-settings/kolab_config.txt new file mode 100644 index 00000000..8237205d --- /dev/null +++ b/source/administrator-guide/roundcube-settings/kolab_config.txt @@ -0,0 +1 @@ +``kolab_config`` has no configuration options. diff --git a/source/administrator-guide/roundcube-settings/kolab_delegation.txt b/source/administrator-guide/roundcube-settings/kolab_delegation.txt new file mode 100644 index 00000000..b16525af --- /dev/null +++ b/source/administrator-guide/roundcube-settings/kolab_delegation.txt @@ -0,0 +1,18 @@ +``kolab_delegation_filter`` +=========================== + +Delegation plugin uses LDAP addressbook defined in ``kolab_auth`` plugin. This option will overwrite defined LDAP filter. +Default: ``(|(objectClass=kolabInetOrgPerson)(&(objectclass=kolabsharedfolder)(kolabFolderType=mail)))``. + +``kolab_delegation_delegate_field`` +=================================== + +Delegates field (from fieldmap configuration) to get delegates list. Note: This is a field name, not LDAP attribute name. +Default: ``kolabDelegate``. + +``kolab_delegation_purge_identities`` +===================================== + +Delegation plugin creates automatically identities for delegator's addresses. After the delegation is removed identities should be removed too. +This option removes all user identities which do not match the user's primary or alias addresses and delegator's addresses. +Default: ``false``. diff --git a/source/administrator-guide/roundcube-settings/kolab_files.txt b/source/administrator-guide/roundcube-settings/kolab_files.txt new file mode 100644 index 00000000..f57f669e --- /dev/null +++ b/source/administrator-guide/roundcube-settings/kolab_files.txt @@ -0,0 +1,26 @@ +``kolab_files_url`` +=================== + +An URL of kolab-chwala installation. Example: ``$config['kolab_files_url'] = 'https://localhost/kolab-chwala/public_html';``. + +``kolab_files_list_cols`` +========================= + +Default list of columns on files list. Available are: ``name``, ``size``, ``mtime``, ``type``. +Example: ``$config['kolab_files_list_cols'] = array('name', 'mtime', 'size');`` + +``kolab_files_sort_col`` +======================== + +Name of the column to sort files list by. Default: `name``. + +``kolab_files_sort_order`` +========================== + +Order of the files list sort. Default: ``asc``. + +``kolab_files_search_threads`` +============================== + +Number of concurent requests for searching and collections listing. Default: ``1``. +Increasing this number may improve performance of multi-folder searches, but also increase server load. diff --git a/source/administrator-guide/roundcube-settings/kolab_folders.txt b/source/administrator-guide/roundcube-settings/kolab_folders.txt new file mode 100644 index 00000000..de0c5d14 --- /dev/null +++ b/source/administrator-guide/roundcube-settings/kolab_folders.txt @@ -0,0 +1,18 @@ +``kolab_folders_configuration_default`` +``kolab_folders_event_default`` +``kolab_folders_contact_default`` +``kolab_folders_task_default`` +``kolab_folders_note_default`` +``kolab_folders_journal_default`` +``kolab_folders_file_default`` +``kolab_folders_freebusy_default`` +``kolab_folders_mail_inbox`` +``kolab_folders_mail_drafts`` +``kolab_folders_mail_sentitems`` +``kolab_folders_mail_wastebasket`` +``kolab_folders_mail_outbox`` +``kolab_folders_mail_junkemail`` +================================ + +Default kolab-specific folders. Set values to non-empty strings to create default folders of apropriate type. +If there is no such folder with specified type in user mailbox, it will be created. Note that mail folders will be also subscribed. diff --git a/source/administrator-guide/roundcube-settings/libcalendaring.txt b/source/administrator-guide/roundcube-settings/libcalendaring.txt new file mode 100644 index 00000000..a173751e --- /dev/null +++ b/source/administrator-guide/roundcube-settings/libcalendaring.txt @@ -0,0 +1 @@ +This plugin contains code shared by other plugins and itself does not have any configuration. diff --git a/source/administrator-guide/roundcube-settings/managesieve.txt b/source/administrator-guide/roundcube-settings/managesieve.txt new file mode 100644 index 00000000..0de7bb77 --- /dev/null +++ b/source/administrator-guide/roundcube-settings/managesieve.txt @@ -0,0 +1,124 @@ +``managesieve_port`` +==================== + +Managesieve server port. When empty the port will be determined automatically +using getservbyname() function, with 4190 as a fallback. + +``managesieve_host`` +==================== + +Managesieve server address, default is ``localhost``. +Replacement variables supported in host name: +``%h`` - user's IMAP hostname +``%n`` - http hostname ($_SERVER['SERVER_NAME']) +``%d`` - domain (http hostname without the first part) +For example ``%n`` = mail.domain.tld, ``%d`` = domain.tld + +``managesieve_auth_type`` +========================= + +Authentication method. Can be ``CRAM-MD5``, ``DIGEST-MD5``, ``PLAIN``, ``LOGIN``, ``EXTERNAL`` or none. +Optional, defaults to best method supported by the server. + +``managesieve_auth_cid`` +======================== + +Optional managesieve authentication identifier to be used as authorization proxy. +Authenticate as a different user but act on behalf of the logged in user. +Works with ``PLAIN`` and ``DIGEST-MD5`` authentication. + +``managesieve_auth_pw`` +======================= + +Optional managesieve authentication password to be used for ``managesieve_auth_cid``. + +``managesieve_usetls`` +====================== + +Use or not TLS for managesieve server connection. Note that tls:// prefix in managesieve_host is also supported + +``managesieve_conn_options`` +============================ + +Connection socket context options. See http://php.net/manual/en/context.ssl.php +The example below enables server certificate validation: + +.. code-block:: php + + $config['managesieve_conn_options'] = array( + 'ssl' => array( + 'verify_peer' => true, + 'verify_depth' => 3, + 'cafile' => '/etc/openssl/certs/ca.crt', + ), + ); + +``managesieve_default`` +======================= + +Path to a file with default contents of filters script (e.g. default spam filter) + +``managesieve_script_name`` +=========================== + +The name of the script which will be used when there's no user script. Default: ``managesieve``. + +``managesieve_mbox_encoding`` +============================= + +Sieve RFC says that we should use UTF-8 endcoding for mailbox names, but some implementations does not covert UTF-8 to modified UTF-7. +Defaults to ``UTF-8``. + +``managesieve_disabled_extensions`` +=================================== + +An array containing a list of disabled protocol extensions. This way you can limit managesieve features awailable to the user. + +``managesieve_debug`` +===================== + +Enables debugging of conversation with sieve server. Logs it into /sieve + +``managesieve_kolab_master`` +============================ + +Enables features described in http://wiki.kolab.org/KEP:14. Disabled by default. + +``managesieve_filename_extension`` +================================== + +Script name extension used for scripts including. Dovecot uses '.sieve', Cyrus uses '.siv'. Doesn't matter if you have ``managesieve_kolab_master`` disabled. +Default is ``.sieve``. + +``managesieve_filename_exceptions`` +=================================== + +List of reserved script names (without extension). Scripts listed here will be not presented to the user. + +``managesieve_domains`` +======================= + +List of domains limiting destination emails in redirect action. If not empty, user will need to select domain from a list. + +``managesieve_vacation`` +======================== + +Enables separate management interface for vacation responses (out-of-office). +Possible values: 0 - no separate section (default), 1 - add Vacation section, 2 - add Vacation section, but hide Filters section. + +``managesieve_vacation_interval`` +================================= + +Default vacation interval (in days). +Note: If server supports vacation-seconds extension it is possible to define interval in seconds here (as a string), e.g. ``3600s``. + +``managesieve_vacation_addresses_init`` +======================================= + +Some servers require vacation :addresses to be filled with all user addresses (aliases). +This option enables automatic filling of these on initial vacation form creation. + +``managesieve_notify_methods`` +============================== + +List of supported methods of notify extension. Default: ``mailto``. diff --git a/source/administrator-guide/roundcube-settings/messages_cache.txt b/source/administrator-guide/roundcube-settings/messages_cache.txt index 3539515d..4a657508 100644 --- a/source/administrator-guide/roundcube-settings/messages_cache.txt +++ b/source/administrator-guide/roundcube-settings/messages_cache.txt @@ -1,19 +1,18 @@ .. _admin_roundcube-settings_messages_cache: ``messages_cache`` ================== Controls whether or not to cache messages. Valid configuration values are limited to ``db`` only, for message caching makes extensive use of the relational capabilities of the database. Store cached messages in the database configured with :ref:`admin_roundcube-settings_db_dsnw`. .. seealso:: * :ref:`admin_roundcube-settings_messages_cache_threshold` * :ref:`admin_roundcube-settings_messages_cache_ttl` * :ref:`admin_roundcube-settings-plugin_libkolab_kolab_messages_cache_bypass` - * :ref:`admin_roundcube-settings-plugin_threading_as_default` diff --git a/source/administrator-guide/roundcube-settings/password.txt b/source/administrator-guide/roundcube-settings/password.txt new file mode 100644 index 00000000..7db16af6 --- /dev/null +++ b/source/administrator-guide/roundcube-settings/password.txt @@ -0,0 +1,45 @@ +``password_driver`` +=================== + +A driver to use for password change. Default: `sql`. + +``password_confirm_current`` +============================ + +Determine whether current password is required to change password. Default: true. + +``password_minimum_length`` +=========================== + +Require the new password to be a certain length. Set to blank to allow passwords of any length. + +``password_require_nonalpha`` +============================= + +Require the new password to contain a letter and punctuation character. Change to false to remove this check. + +``password_log`` +================ + +Enables logging of password changes into logs/password file. + +``password_login_exceptions`` +============================= + +Comma-separated list of login exceptions for which password change will be not available (no Password tab in Settings). + +``password_hosts`` +================== + +An array of hosts that support password changing. Default is NULL. +Listed hosts will feature a Password option in Settings, others will not. + +``password_force_save`` +======================= + +Enables saving the new password even if it matches the old password. Useful for upgrading the stored passwords after the encryption scheme has changed. + +``password_force_new_user`` +=========================== + +Enables forcing new users to change their password at their first login. diff --git a/source/administrator-guide/roundcube-settings/redundant_attachments.txt b/source/administrator-guide/roundcube-settings/redundant_attachments.txt new file mode 100644 index 00000000..cad77600 --- /dev/null +++ b/source/administrator-guide/roundcube-settings/redundant_attachments.txt @@ -0,0 +1,11 @@ +``redundant_attachments_cache_ttl`` +=================================== + +By default this plugin stores attachments in filesystem and copies them into sql database. +In environments with replicated database it is possible to use memcache as a fallback when write-master is unavailable. +This option enables this memcache use as a fallback store. + +``redundant_attachments_cache_ttl`` +=================================== + +Attachment data expires after specified TTL time in seconds (max. 2592000). Default is 12 hours. diff --git a/source/administrator-guide/roundcube-settings/tasklist.txt b/source/administrator-guide/roundcube-settings/tasklist.txt new file mode 100644 index 00000000..a496a7f2 --- /dev/null +++ b/source/administrator-guide/roundcube-settings/tasklist.txt @@ -0,0 +1,15 @@ +``tasklist_driver`` +=================== + +Backend type (``database``, ``kolab``). Default is ``kolab``. + +``tasklist_sort_col`` +===================== + +Default sorting order of tasks listing (``auto``, ``datetime``, ``startdatetime``, ``flagged``, ``complete``, ``changed``). + +``tasklist_sort_order`` +======================= + +Default sorting order for tasks listing (``asc`` or ``desc``). Default is ``asc``. +