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 --- 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 --- 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 --- 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 --- 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 --- 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 --- 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 --- 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 --- a/source/administrator-guide/roundcube-settings-reference.rst +++ b/source/administrator-guide/roundcube-settings-reference.rst @@ -208,11 +208,6 @@ .. 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 -------------- @@ -365,8 +360,7 @@ 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: @@ -380,26 +374,36 @@ 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 @@ -415,27 +419,32 @@ 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 --- 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 --- 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 --- a/source/administrator-guide/roundcube-settings/calendar.txt +++ b/source/administrator-guide/roundcube-settings/calendar.txt @@ -26,7 +26,7 @@ Calendar name -``%i` +``%i`` Calendar UUID diff --git a/source/administrator-guide/roundcube-settings/kolab_activesync.txt b/source/administrator-guide/roundcube-settings/kolab_activesync.txt new file mode 100644 --- /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 --- /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 --- /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 --- /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 --- /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 --- /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 --- /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 --- /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 --- a/source/administrator-guide/roundcube-settings/messages_cache.txt +++ b/source/administrator-guide/roundcube-settings/messages_cache.txt @@ -16,4 +16,3 @@ * :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 --- /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 --- /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 --- /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``. +