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