diff --git a/languages/en/administration-guide/application-management/configuration-variables.rst b/languages/en/administration-guide/application-management/configuration-variables.rst index 457262f17..c6feac19d 100644 --- a/languages/en/administration-guide/application-management/configuration-variables.rst +++ b/languages/en/administration-guide/application-management/configuration-variables.rst @@ -7,6 +7,9 @@ The following table, presents the list of variables with their default values. Please note that the modern version of managing configuration variables is done with ``tuleap config-[set,get]``, you can get the list of variables with their default values with ``tuleap config-list``. +Global Configuration +```````````````````` + +---------------------------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Variable name | Default | Description | +=============================================+=============================================+==============================================================================================================================================================================================================================================================+ @@ -20,7 +23,7 @@ Please note that the modern version of managing configuration variables is done +---------------------------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | $sys_email_contact | ``codendi-contact@%sys_default_domain%`` | Email address pointing to the Tuleap contacts for use Web pages, documentation, etc. | +---------------------------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sys_noreply | ``"Tuleap" `` | Address from which emails are sent | +| $sys_noreply | ``"Tuleap" `` | Address from which emails are sent | +---------------------------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | $sys_supported_languages | ``en_US, fr_FR, pt_BR, ko_KR`` | Supported languages (separated comma). Only en_US, fr_FR and pt_BR are available for now. Exemple: ``en_US, fr_FR``. | +---------------------------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -77,4 +80,124 @@ Please note that the modern version of managing configuration variables is done || || || You have to ensure those headers are properly set by your reverse proxy. Otherwise it might be an injection point for an attacker. | +---------------------------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | $sys_mail_secure_mode | ``0`` | When 0 mail sent to everybody can lead to information leak, non projects members can receive mails of private projects | -+---------------------------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ \ No newline at end of file ++---------------------------------------------+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Archive deleted items +````````````````````` + ++---------------+----------+-------------------------------+ +| Variable name | Default | Description | ++===============+==========+===============================+ +| $archive_path | ``/tmp`` | Path of the archive directory | ++---------------+----------+-------------------------------+ + +Docman +`````` + ++----------------------------+----------------------------+-------------------------------------------+ +| Variable name | Default | Description | ++============================+============================+===========================================+ +| $docman_root | ``/var/lib/tuleap/docman`` | Where the documentation files are located | ++----------------------------+----------------------------+-------------------------------------------+ +| $embedded_are_allowed | ``true`` | Are embedded files allowed ? | ++----------------------------+----------------------------+-------------------------------------------+ +| $only_siteadmin_can_delete | ``false`` | | ++----------------------------+----------------------------+-------------------------------------------+ + +Git +``` + ++------------------------+----------+-----------------------------------------------------------------------------------------------+ +| Variable name | Default | Description | ++========================+==========+===============================================================================================+ +| $git_backup_dir | ``/tmp`` | Backup directory | ++------------------------+----------+-----------------------------------------------------------------------------------------------+ +| $weeks_number | ``12`` | Number of weeks displayed in widget last project pushes | ++------------------------+----------+-----------------------------------------------------------------------------------------------+ +| $git_use_friendly_urls | ``1`` | Tell tuleap to use user friendly URLs in Git Plugin (eg: /git/plugins/project_name/repo_path) | ++------------------------+----------+-----------------------------------------------------------------------------------------------+ + +LDAP +```` +LDAP comes with two default configurations, one for Active Directory and one for OpenLDAP. Please adjust to your settings. + ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Variable | Default | Description | ++================================================+========================================================================================================================================================+========================================================================================================================================================================================================================================================================+ +| $sys_ldap_server_common_name | ``Active Directory`` or ``LDAP`` | How people refer to the Active Directory server, most of the time it's "Active Directory" but it can be "LDAP" or "Enterprise Directory", ... . This value is used in Tuleap screens to refer to the server like "Enter your $sys_ldap_server_common_name credentials" | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_server | ``%sys_ldap_server%`` | | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_server_type | ``ActiveDirectory`` or ``OpenLDAP`` | The type of server being used. This can take one of two values "OpenLDAP" or "ActiveDirectory". Any value other that 'ActiveDirectory' will default to "OpenLDAP" | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_dn | ``dc=example,dc=com`` | To enable LDAP information on Tuleap users, also define the DN (distinguised name) to use in LDAP queries. The ldap filter is the filter to use to query the LDAP directory (%name% are substituted with the value from the user table) | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_uid | ``sAMAccountName`` or ``uid`` | User login (authentication 1st step) | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_eduid | ``sAMAccountName`` or ``employeeNumber`` | User unique identifier (authentication 2st step). It's probably not the uid (or login) because it may change. This is a value that never change whatever happens to the user (even after deletion). It correspond to ldap_id field in user table in database. | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_cn | ``cn`` | User common name | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_mail | ``mail`` | User email address | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_people_dn | ``dc=example,dc=com`` or ``ou=people,dc=example,dc=com`` | Specific DN to look for people. You may use more than one DN separated by ";" if you want to use several branches. Example : ``ou=People, dc=example, dc=com ; ou=Extranet, dc=example, dc=com`` | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_search_user | ``(|(sAMAccountName=%words%)(cn=%words%)(mail=%words%))`` or ``(|(uid=%words%)(cn=%words%)(mail=%words%))`` |Filter used to look for user. It should cover a wide selection offields because it's aim to find a user whatever it's given (email, name, login, etc). | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_default_user_status | ``A`` | On account creation, what it the default user status (A, R, ...) | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_svn_auth | ``0`` or ``1`` | Enable LDAP based authentication for SVN by default for new projects | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_daily_sync | ``1`` | Enable LDAP daily synchronization | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_daily_sync_retention_period | ``1`` or ``''`` | This Period of retention (in days) added to the date on which the LDAP daily synchronization was ran in order to compute the forecast date of the cleanup of suspended users. | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_user_management | ``1`` | Enable usage of LDAP for people management. For instance autocompletion on user list automatic creation of users not already referenced in the forge. | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_grp_enabled | ``1`` | Enable ldap group management. This allows to mirror a LDAP group defined in LDAP directory within the forge. Doesn't work yet with only works with OpenLDAP compatible directories yet. | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_grp_sync_admin_notifications_enabled | ``0`` | Enabled email notifications for project admins after each project sync. | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_grp_dn | ``ou=groups, dc=example, dc=com`` | Specific DN where the user groups are. | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|| $sys_ldap_grp_search_scope || ``onelevel`` || How group search is performed | +|| || || - either 'onelevel' for search only within $sys_ldap_grp_dn branch | +|| || || - or 'subtree' for a recursive look-up | +|| || || be careful with the later, as it's used in autocompleter, LDAP server performances are critical for good responsiveness | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_grp_cn | ``cn`` | Field that represent group name | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_grp_member | ``member`` or ``uniquemember`` | Field that indicate the membership of a user in a group | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_grp_uid | ``sAMAccountName`` | Group identifier (for ActiveDirectory servers only) | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_grp_oc | ``group`` | objectclass that distinguish groups | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_user_oc | ``person`` | objectclass that distinguish users | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| $sys_ldap_threshold_users_suspension | ``''`` | Threshold for users to be suspended. On beyond of this value expressed in percentage no users will be suspended. | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|| $search_depth || ``subtree`` || Search depth for daily sync | +|| || || ``onelevel``: search for users only into the level immediately below $sys_ldap_people_dn | +|| || || ``subtree`` : search for users into all $sys_ldap_people_dn subtrees (default) | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Tracker date reminder +````````````````````` + ++---------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Variable name | Default | Description | ++===============+===========+=========================================================================================================================================================================================================+ +| $enable_log | ``false`` | Turn it to true to produce logging info into ``/var/log/tuleap/tracker_date_reminder.log`` file. Be careful, the file might grow quickly, activate it only for debug purpose on a short period of time. | ++---------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Webdav +`````` + ++-----------------------+----------------+----------------------------------------------------------------+ +| Variable name | Default | Description | ++=======================+================+================================================================+ +| $max_file_size | ``2147483647`` | Maximum file size allowed ( 2147583647 bit = 2^31-1 bit =2GB ) | ++-----------------------+----------------+----------------------------------------------------------------+ +| $write_access_enabled | ``false`` | Used to enable/disable write access from WebDAV | ++-----------------------+----------------+----------------------------------------------------------------+ \ No newline at end of file