Work in progress creating a repo
[timetracker.git] / readme.txt
1 Anuko Time Tracker.
2 Copyright (c) Anuko (https://www.anuko.com).
3
4 Project home page: https://www.anuko.com/time_tracker/index.htm
5 Free hosting of Time Tracker for individuals and small teams is available at https://timetracker.anuko.com
6
7 Each file in this archive is protected by the LIBERAL FREEWARE LICENSE. 
8 Read the file license.txt for details.
9
10
11 INSTALLATION INSTRUCTIONS
12
13 Detailed documentation is available at https://www.anuko.com/time_tracker/install_guide/index.htm
14
15 The general installation procedure looks like this:
16
17 - Install a web server and make sure it can serve HTML documents.
18 - Install PHP, configure your server to work with PHP scripts, and make sure it can work with PHP files. 
19 - Install the following PHP extensions: MySQL and GD. The GD extension is needed for pie-charts only.
20 - Install a database server such as MySQL and make sure it is working properly. 
21 - Install, configure, and test Anuko Time Tracker like so: 
22
23 1) Unpack distribution files into a selected directory for Apache web server.
24 2) Create a database using the mysql.sql file in the distribution.
25 3) If you are upgrading from earlier versions run dbinstall.php from your browser and do the required "Update database structure" steps.
26 4) Create user name and password to access the time tracker database. 
27 5) Change $dsn value in /WEB-INF/config.php file to reflect your database connection parameters (user name and password).
28 6) For UNIX systems set full access rights for catalog WEB-INF/templates_c/ (chmod 777 templates_c).
29 7) If you install time tracker into a sub-directory of your site reflect this in the APP_NAME parameter in /WEB-INF/config.php file. For example, for http://localhost/timetracker/ set APP_NAME = "timetracker".
30 8) Login to your time tracker site as admin with password "secret" without quotes and create at least one team.
31 9) Change admin password (on the admin "options" page). You can also use the following SQL console command: 
32   update tt_users set password = md5('new_password_here') where login='admin'
33   or by using the "Change password of administrator account" option in http://your_time_tracker_site/dbinstall.php
34 10) Test if everything is working.
35 11) Remove dbinstall.php file from your installation directory.
36
37
38 UPGRADE FROM EARLIER VERSIONS
39
40 See https://www.anuko.com/time_tracker/upgrade.htm
41
42
43 BLANK PAGES IN TIME TRACKER
44
45 If you see a blank page in when trying to access Anuko Time Tracker it may mean many things, among others, such as:
46
47     * MySQL extension for PHP not installed or not working.
48     * Time tracker database not created.
49     * Access (login / password) to the database is not configured properly in config.php.
50     * MySQL service is down. 
51     * On UNIX systems - no full access rights for catalog WEB-INF/templates_c/ (chmod 777 templates_c).
52
53 You need to thoroughly test each and every component to make sure they work together nicely.
54
55
56 INSTALLATION / UPGRADES / DATA MIGRATION HELP
57
58 Support is available on per-incident basis - see https://www.anuko.com/support.htm
59
60
61 CHANGE LOG
62
63 Change log is available at https://www.anuko.com/time_tracker/change_log/index.htm