This manual is deprecated. Please visit https://groupoffice.readthedocs.io for the latest documentation. |
Configuration file
From Group-Office Groupware and CRM Documentation
The values described here can be put in your config.php file as $config['varname']='value'; The file can be located in:
- /etc/groupoffice/config.php
- /etc/groupoffice/<APACHE SERVER_NAME>/config.php
- The Group-Office directory or any of it's parent directories.
Contents
- 1 Config file settings lists
- 1.1 General settings list
- 1.2 Password settings list
- 1.3 Localization settings list
- 1.4 User settings list
- 1.5 User group settings list
- 1.6 Debugging and logging settings list
- 1.7 Database settings list
- 1.8 File browser settings list
- 1.9 Email settings list
- 1.10 Group-Office system SMTP settings list
- 1.11 Settings not set by the installer
- 1.12 External program settings list
Config file settings lists
General settings list
Name | Default | Description |
---|---|---|
enabled | true | Enable the Group-Office installation |
id | "groupoffice" | Group-Office server ID |
default_theme | "Default" | Default theme. |
defaultView | "Extjs3" | Default view, Model-View-Controller-wise. |
allowed_modules | "" | Comma separated list of allowed modules. Leave empty to allow all modules. |
html_editor_font | "font-size:13px; font-family:Arial, Helvetica, sans-serif;" | The font used in all HTML editor including the E-mail editor. |
full_url | "" | Full URL to reach Group-Office with slash on end. This value is determined automatically if not set in config.php. |
orig_full_url | "" | Full original URL to reach Group-Office with slash on end. |
host | "/groupoffice/" | Relative hostname with slash on both start and end. |
title | "" | Title of Group-Office |
webmaster_email | "webmaster@example.com" | The email address of the webmaster. |
root_path | "" | The path to the root of Group-Office with slash on end. |
tmpdir | "/tmp/" | The path to store temporary files with slash on end. Leave to ../ for installation. |
quota | "0" | The maximum number KB this Group-Office installation may use. 0 will allow unlimited usage of disk space. |
date_formats | array('dmY','mdY','Ymd'); | Date formats to be used. Only Y, m and d are supported. |
date_separators | array('-','.','/'); | Date separators to be used. |
time_formats | array('G:i','g:i a'); | Time formats to be used. |
module_path | "modules" | Relative path to the modules directory with no slash at start and end. |
configuration_url | "configuration" | Relative URL to the administrator directory with no slash at start and end. |
help_link | "http://wiki4.group-office.com/wiki/" | The link in menu help -> contents. |
class_path | "classes" | Relative path to the classes directory with no slash at start and end. |
control_path | "controls" | Relative path to the controls directory with no slash at start and end. |
theme_path | "themes" | Relative path to the themes directory with no slash at start and end. |
theme_url | "themes" | Relative URL to the themes directory with no slash at start and end. |
language_path | "language" | Relative path to the language directory with no slash at start and end. |
orig_tmpdir | "" | Original tmpdir. The user_id is appended (/tmp/1/) to the normal tmpdir. In some cases you don't want that. |
zlib_compress | true | Enable zlib compression for faster downloading of scripts and css |
product_name | "Group-Office" | The product name. |
product_name | "Group-Office" | The product name. |
nav_page_size | "50" | The number of items displayed in the navigation panels (Calendars, addressbooks etc.) Don't set this number too high because it may slow the browser and server down. |
curl_proxy | "" | If you are behind a proxy you can set it here for all CURL operations Group-Office performs. |
default_max_rows_list | "30" | The default maximum size of lists. |
Password settings list
Name | Default | Description |
---|---|---|
password_validate | true | Enable password validation |
password_min_length | "6" | Minimum required password length |
password_require_uc | true | Require an uppercase characters |
password_require_lc | true | Require a lowercase characters |
password_require_num | true | Require a number |
password_require_sc | true | Require a special char |
password_require_uniq | "3" | Required number of unique characters |
default_password_length | "6" | Length of the password generated when a user uses the lost password option. |
disable_security_token_check | false | Disable security check for cross domain forgeries. |
force_ssl | false | Force an HTTPS connection in the main /index.php |
session_inactivity_timeout | "0" | Automatically log a user out after n seconds of inactivity. |
Localization settings list
Name | Default | Description |
---|---|---|
language | "en" | Default language |
default_country | "NL" | Default country |
default_vat | "21" | Default VAT percentage |
default_timezone | "Europe/Amsterdam" | Default timezone |
default_currency | "€" | Default currency |
default_date_format | "dmY" | Default date format |
default_date_separator | "-" | Default date separator |
default_time_format | "G:i" | Default time format |
default_sort_name | "last_name" | Default name formatting and sorting. Can be last_name or first_name. |
default_first_weekday | "1" | Default first day of the week: 0=sunday 1=monday. |
default_decimal_separator | "," | Default decimal separator for numbers. |
default_thousands_separator | '.' | Default thousands separator for numbers. |
User settings list
Name | Default | Description |
---|---|---|
allow_themes | true | Enable theme switching by users |
allow_password_change | true | Enable password changing by users |
allow_profile_edit | true | Enable profile editing by every user through the settings dialog |
allow_registration | false | Enable user registration by everyone |
allow_duplicate_email | false | Allows email addresses to occur more than once over the user profiles |
register_modules_read | "" | Grant read permissions for these modules to new self-registered users. Module names are separated by a comma. |
register_modules_write | "" | Grant write (i.e., management) permissions for these modules to new self-registered users. Module names are separated by a comma. |
register_user_groups | "" | Add self-registered users to these user groups. Group names are separated by a comma. |
register_visible_user_groups | "Everyone" | Add self-registered users will be visible to these user groups. Group names are separated by a comma. |
max_users | 0 | The maximum number of users. |
limit_usersearch | 0 | If set, user queries will only return this maximum number of users. Useful in large environments where you don't want users to scroll through all. |
User group settings list
Name | Default | Description |
---|---|---|
group_root | "1" | The "Administrators" user group ID |
group_everyone | "2" | The "Everyone" user group ID |
group_internal | "3" | The "Internal" user group ID |
Debugging and logging settings list
Name | Default | Description |
---|---|---|
debug | false | Run Group-Office in debug mode. |
debug_display_errors | true | Output errors in debug mode. |
debug_log | false | Just enable the debug log. See debug.log in your Group-Office log folder. |
debug_log_remote_ip | "" | Only log debug messages for this remote IP address. |
log_max_days | 14 | Set the number of days the database log will contain until it will be dumped to a CSV file on disk. The log module must be installed. |
firephp | false | Enable FirePhp |
info_log | "" | Info log location. If empty it will be in <file_storage_path>/log/info.log |
log | false | Enable syslog |
Database settings list
Name | Default | Description |
---|---|---|
db_type | mysql | The database type to use. Currently only MySQL is supported. |
db_host | "" | The host of the database |
db_name | "" | The name of the database |
db_user | "" | The username to connect to the database |
db_pass | "" | The password to connect to the database |
db_port | "3306" | Specifies the port number to attempt to connect to the MySQL server. |
db_socket | "" | Specifies the socket or named pipe that should be used. |
db_auto_increment_increment | 1 | Useful in clustering mode. Set to the number of clustered nodes. |
db_auto_increment_offset | 1 | Give each node an incremented number. |
File browser settings list
Name | Default | Description |
---|---|---|
file_storage_path | "/home/groupoffice" | The path to the location where the files of the file browser module are stored. This path should NEVER be inside the document root of the webserver. This directory should be writable by apache. Furthermore, choose a partition that has enough diskspace. |
gota_blacklist_extensions | array('log','pdf','zip','tar','gz') | List of extensions that should not be edited with GOTA by default. |
convert_utf8_filenames_to_ascii | false | Convert non ASCII characters to ASCII codes when uploaded to Group-Office. Useful for Windows servers that don't support UTF8. |
max_file_size | 10000000 | The maximum file size that the file browser may upload. Note that the php.ini file must be set accordingly (http://www.php.net). |
max_file_versions | 3 | Maximum number of old file versions to keep. -1 will disable versioning. 0 will keep an infinite number of versions (Be careful!). |
Email settings list
Name | Default | Description |
---|---|---|
smtp_server | "localhost" | The SMTP host to use |
smtp_port | "25" | The SMTP port to use |
smtp_username | "" | The SMTP username for authentication (empty for no authentication) |
smtp_password | "" | The SMTP password for authentication |
smtp_encryption | "" | Leave blank or set to "tls" or "ssl" |
smtp_local_domain | "" | The Swift mailer component auto detects the domain you are connecting from. In some cases it fails and uses an invalid IPv6 IP like ::1. You can override it here. |
swift_qp_dot_escape | false | A special Swift preference to escape dots. For some buggy SMTP servers this is necessary. |
email_disable_aliases | false | Set to true to prevent users from changing their e-mail aliases in the email module. |
disable_imap_capabilities | "" | We stumbled upon a dovecot server that crashed when sending a command using LIST-EXTENDED. With this option we can workaround that issue. |
restrict_smtp_hosts | "" | A comma separated list of smtp server IP addresses that you want to restrict. E.g. "213.207.103.219:10,127.0.0.1:10"; will restrict those IP's to 10 e-mails per day. |
max_attachment_size | "10000000" | The maximum size of e-mail attachments the browser attempts to upload. Note that the php.ini file must be set accordingly (http://www.php.net). |
Group-Office system SMTP settings list
Name | Default | Description |
---|---|---|
smtp_account_id | false | Enable sending system emails with an email account from the email module. Needs to be the id of the wanted mail account. |
smtp_account_smime_sign | false | Enable Smime for outgoing system emails. Note: this only works when a mailaccount is used to send the system emails (Please see: $smtp_account_id) |
smtp_account_smime_password | "" | The password that is needed to sign the Smime certificate for outgoing system emails. Note: this is only needed when a mailaccount is used to send the system emails (Please see: smtp_account_id) and when smtp_account_smime_sign is set to true |
password_require_num | true | Require a number |
password_require_sc | true | Require a special char |
password_require_uniq | 3 | Required number of unique characters |
Settings not set by the installer
Name | Default | Description |
---|---|---|
version | e.g., "4.1.28" | The Group-Office version number |
file_create_mode | "0644" | The permissions mode to use when creating files |
folder_create_mode | "0755" | The permissions mode to use when creating folders |
file_change_group | "" | Sets Group-Office files to this file system group. |
mtime | e.g., "20130131" | Modification date |
mtime | e.g., "20130131" | Modification date |
External program settings list
Name | Default | Description |
---|---|---|
cmd_zip | "/usr/bin/zip" | Command to create ZIP archive. |
cmd_unzip | "/usr/bin/unzip" | Command to unpack ZIP archive. |
cmd_tar | "/bin/tar" | Command to control TAR archives. |
cmd_sudo | "/usr/bin/sudo" | Command to set system passwords. Used by passwd.users.class.inc. SUDO must be set up! |
cmd_chpasswd | "/usr/sbin/chpasswd" | Command to SUDO. |
cmd_xml2wbxml | "/usr/bin/xml2wbxml" | Command to convert xml to wbxml. |
cmd_wbxml2xml | "/usr/bin/wbxml2xml" | Command to convert wbxml to bxml. |
cmd_tnef | "/usr/bin/tnef" | Command to unpack winmail.dat files. |
cmd_php | "php" | Command to execute the php command line interface. |
callto_template | "callto:{phone}" | Template of "Callto: link". |
disable_flash_upload | false | Don't use flash to upload. In some cases it doesn't work like when using a self-signed certificate. |