Soem refactoring to keep things a bit more consistent.
[timetracker.git] / WEB-INF / config.php.dist
1 <?php
2 // +----------------------------------------------------------------------+
3 // | Anuko Time Tracker
4 // +----------------------------------------------------------------------+
5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
6 // +----------------------------------------------------------------------+
7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
8 // | by anyone for any purpose, and freely redistributed alone or in
9 // | combination with other software, provided that the license is obeyed.
10 // |
11 // | There are only two ways to violate the license:
12 // |
13 // | 1. To redistribute this code in source form, with the copyright
14 // |    notice or license removed or altered. (Distributing in compiled
15 // |    forms without embedded copyright notices is permitted).
16 // |
17 // | 2. To redistribute modified versions of this code in *any* form
18 // |    that bears insufficient indications that the modifications are
19 // |    not the work of the original author(s).
20 // |
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
23 // |
24 // +----------------------------------------------------------------------+
25 // | Contributors:
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
28
29
30 // Set include path for PEAR and its modules, which we include in the distribution.
31 //
32 set_include_path(realpath(dirname(__FILE__).'/lib/pear') . PATH_SEPARATOR . get_include_path());
33
34
35 // Database connection parameters.
36 //
37 // CHANGE 3 PARAMETERS HERE!
38 // In this example: "root" is username, "no" is password, "dbname" is database name.
39 //
40 define('DSN', 'mysqli://root:no@localhost/dbname?charset=utf8');
41 // Do NOT change charset unless you upgraded from an older Time Tracker where charset was NOT specified
42 // and now you see some corrupted characters. See http://dev.mysql.com/doc/refman/5.0/en/charset-mysql.html
43
44
45 // MULTITEAM_MODE option defines whether users can create their own teams.
46 //
47 // Available values are true or false.
48 // If true users can create their own teams.
49 // If false only admin can create teams.
50 //
51 define('MULTITEAM_MODE', true);
52
53
54 // Application name.
55 // If you install time tracker into a sub-directory of your site reflect this in the APP_NAME parameter.
56 // For example, for http://localhost/timetracker/ define APP_NAME as 'timetracker'.
57 //
58 // define('APP_NAME', 'timetracker');
59 //
60 define('APP_NAME', '');
61
62
63 // OLD_PASSWORDS
64 //
65 // You may need to set this option if you migrate an older version of TT installation to a new server.
66 // Older versions of TT used mysql password function to hash user passwords. Newer versions use md5.
67 // Because the password function may behave differently between servers, the OLD_PASSWORD settings
68 // gives you an opportunity to control it, if needed.
69 //  
70 // define('OLD_PASSWORDS', true);
71
72
73 // Holidays. At this time holiday days are defined in the localization files (one file per language).
74 // The SHOW_HOLIDAYS option defines whether holidays are highlighted with holiday color.
75 //
76 define('SHOW_HOLIDAYS', true);
77
78
79 // COST_ON_REPORTS - defines the availability of the Cost field on the Reports page.
80 //
81 define('COST_ON_REPORTS', true);
82
83
84 // READONLY_START_FINISH - defines whether the start and finish fields on time entry pages are read-only.
85 // This applies to regular users only. Manager and co-managers can edit these values.
86 //
87 // define('READONLY_START_FINISH', false);
88
89
90 // FUTURE_ENTRIES - defines whether users can create entries for future dates. Defaults to true.
91 //
92 // define('FUTURE_ENTRIES', false);
93
94
95 // ALLOW_OVERLAP - defines whether overlapping time entries are allowed. Defaults to false.
96 //
97 // define('ALLOW_OVERLAP', true);
98
99
100 // WEEKEND_START_DAY
101 //
102 // This option defines which days are highlighted with weekend color.
103 // 6 means Saturday. For Saudi Arabia, etc. set it to 4 for Thursday and Friday to be weekend days.
104 //
105 define('WEEKEND_START_DAY', 6);
106
107
108 // PHPSESSID_TTL
109 //
110 // Lifetime in seconds for tt_PHPSESSID cookie. Time to live is extended by this value
111 // with each visit to the site so that users don't have to re-login. 
112 // define('PHPSESSID_TTL', 86400);
113
114
115 // Forum and help links from the main menu.
116 //
117 define('FORUM_LINK', 'https://www.anuko.com/forum/viewforum.php?f=4');
118 define('HELP_LINK', 'https://www.anuko.com/time_tracker/user_guide/index.htm');
119
120
121 // Default sender for mail.
122 //
123 define('SENDER', '"Anuko Time Tracker" <no-reply@timetracker.anuko.com>');
124
125
126 // MAIL_MODE - mail sending mode. Can be 'mail' or 'smtp'.
127 // 'mail' - sending through php mail() function.
128 // 'smtp' - sending directly through SMTP server.
129 // See https://www.anuko.com/time_tracker/install_guide/mail.htm
130 //
131 define('MAIL_MODE', 'smtp');
132 define('MAIL_SMTP_HOST', 'localhost'); // For gmail use 'ssl://smtp.gmail.com' instead of 'localhost' and port 465.
133 // define('MAIL_SMTP_PORT', '465');
134 // define('MAIL_SMTP_USER', 'yourname@yourdomain.com');
135 // define('MAIL_SMTP_PASSWORD', 'yourpassword');
136 // define('MAIL_SMTP_AUTH', true);
137 // define('MAIL_SMTP_DEBUG', true);
138
139
140 // CSS files. They are located in the root of Time Tracker installation.
141 //
142 define('DEFAULT_CSS', 'default.css');
143 define('RTL_CSS', 'rtl.css'); // For right to left languages.
144
145
146 // Default date format. Behaviour with not included formats is undefined. Possible values:
147 // '%Y-%m-%d'
148 // '%m/%d/%Y'
149 // '%d.%m.%Y'
150 // '%d.%m.%Y %a'
151 define('DATE_FORMAT_DEFAULT', '%Y-%m-%d');
152
153
154 // Default time format. Behaviour with not included formats is undefined. Possible values:
155 // '%H:%M'
156 // '%I:%M %p'
157 define('TIME_FORMAT_DEFAULT', '%H:%M');
158
159
160 // Default week start day.
161 // Possible values: 0 - 6. 0 means Sunday.
162 //
163 define('WEEK_START_DEFAULT', 0);
164
165
166 // Default language of the application.
167 // Possible values: en, fr, nl, etc. Empty string means the language is defined by user browser.
168 // 
169 define('LANG_DEFAULT', '');
170
171
172 // Default currency symbol. Use €, £, a more specific dollar like US$, CAD, etc.
173 // 
174 define('CURRENCY_DEFAULT', '$');
175
176
177 // EXPORT_DECIMAL_DURATION - defines whether time duration values are decimal in CSV and XML data exports (1.25 or 1,25 vs 1:15).
178 // 
179 define('EXPORT_DECIMAL_DURATION', true);
180
181
182 // REPORT_FOOTER - defines whether to use a footer on reports.
183 // 
184 define('REPORT_FOOTER', true);
185
186
187 // Authentication module (see WEB-INF/lib/auth/)
188 // Possible authentication methods:
189 //   db - internal database, logins and password hashes are stored in time tracker database.
190 //   ldap - authentication against an LDAP directory such as OpenLDAP or Windows Active Directory.
191 define('AUTH_MODULE', 'db');
192
193 // LDAP authentication examples.
194 // Go to https://www.anuko.com/time_tracker/install_guide/ldap_auth/index.htm for detailed configuration instructions.
195
196 // Configuration example for OpenLDAP server:
197 // define('AUTH_MODULE', 'ldap');
198 // $GLOBALS['AUTH_MODULE_PARAMS'] = array(
199 //  'server' => '127.0.0.1',                    // OpenLDAP server address or name.
200 //  'type' => 'openldap',                       // Type of server. openldap type should also work with Sun Directory Server when member_of is empty.
201                                                 // It may work with other (non Windows AD) LDAP servers. For Windows AD use the 'ad' type.
202 //  'base_dn' => 'ou=People,dc=example,dc=com', // Base distinguished name in LDAP catalog.
203 //  'default_domain' => 'example.com',          // Default domain.
204 //  'member_of' => array());                    // List of groups, membership in which is required for user to be authenticated.
205
206
207 // Configuration example for Windows domains with Active Directory:
208 // define('AUTH_MODULE', 'ldap');
209 // $GLOBALS['AUTH_MODULE_PARAMS'] = array(
210 //  'server' => '127.0.0.1',            // Domain controller IP address or name.
211 //  'type' => 'ad',                     // Type of server.
212 //  'base_dn' => 'DC=example,DC=com',   // Base distinguished name in LDAP catalog.
213 //  'default_domain' => 'example.com',  // Default domain.
214 //  'member_of' => array());            // List of groups, membership in which is required for user to be authenticated.
215
216 // define('AUTH_DEBUG', false); // Note: enabling AUTH_DEBUG breaks redirects as debug output is printed before setting redirect header. Do not enable on production systems.
217
218
219 // Team managers can set monthly work hour quota for years between the following  values.
220 // define('MONTHLY_QUOTA_YEAR_START', 2010); // If nothing is specified, it falls back to 2015.
221 // define('MONTHLY_QUOTA_YEAR_END', 2025);   // If nothing is specified, it falls back to 2030.
222
223 // Height in pixels for the note input field in time.php. Defaults to 40.
224 // define('NOTE_INPUT_HEIGHT', 100);