From 5e8b8a3b26c5d3778efa411158d341032faaac14 Mon Sep 17 00:00:00 2001 From: anuko Date: Fri, 20 Oct 2017 15:22:58 +0000 Subject: [PATCH] Improved readme. --- readme.txt | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/readme.txt b/readme.txt index 437d4c3f..3cc124cf 100644 --- a/readme.txt +++ b/readme.txt @@ -1,38 +1,39 @@ -Anuko Time Tracker. -Copyright (c) Anuko (https://www.anuko.com). +Anuko Time Tracker +Copyright (c) Anuko (https://www.anuko.com) Project home page: https://www.anuko.com/time_tracker/index.htm Free hosting of Time Tracker for individuals and small teams is available at https://timetracker.anuko.com -Each file in this archive is protected by the LIBERAL FREEWARE LICENSE. +Unless otherwise noted, files in this archive are protected by the LIBERAL FREEWARE LICENSE. Read the file license.txt for details. INSTALLATION INSTRUCTIONS -Detailed documentation is available at https://www.anuko.com/time_tracker/install_guide/index.htm +Documentation is available at https://www.anuko.com/time_tracker/install_guide/index.htm The general installation procedure looks like this: - Install a web server and make sure it can serve HTML documents. -- Install PHP, configure your server to work with PHP scripts, and make sure it can work with PHP files. -- Install the following PHP extensions: MySQL and GD. The GD extension is needed for pie-charts only. -- Install a database server such as MySQL and make sure it is working properly. -- Install, configure, and test Anuko Time Tracker like so: - -1) Unpack distribution files into a selected directory for Apache web server. -2) Create a database using the mysql.sql file in the distribution. -3) If you are upgrading from earlier versions run dbinstall.php from your browser and do the required "Update database structure" steps. -4) Create user name and password to access the time tracker database. -5) Change $dsn value in /WEB-INF/config.php file to reflect your database connection parameters (user name and password). -6) For UNIX systems set full access rights for catalog WEB-INF/templates_c/ (chmod 777 templates_c). -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". -8) Login to your time tracker site as admin with password "secret" without quotes and create at least one team. -9) Change admin password (on the admin "options" page). You can also use the following SQL console command: +- Install PHP, configure your server to work with PHP scripts, and make sure it can work with PHP files. +- Install the following PHP extensions: mbstring and GD. The GD extension is needed for pie-charts only. +- Install a database server such as MySQL and make sure it is working properly. +- Install, configure, and test Anuko Time Tracker like so: + +1) Unpack distribution files into a selected directory for your web server. +2) Allow writing to WEB-INF/templates_c/. +3) Create a database using the mysql.sql file in the distribution. +4) Create user name and password to access the time tracker database. +5) Create a config file by coping WEB-INF/config.php.dist to WEB-INF/config.php. +6) Change $dsn value in /WEB-INF/config.php file to reflect your database connection parameters (user name and password). +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. +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". +9) Login to your time tracker site as admin with password "secret" without quotes and create at least one team. +10) Change admin password (on the admin "options" page). You can also use the following SQL console command: update tt_users set password = md5('new_password_here') where login='admin' or by using the "Change password of administrator account" option in http://your_time_tracker_site/dbinstall.php -10) Test if everything is working. -11) Remove dbinstall.php file from your installation directory. +11) Test if everything is working. +12) Remove dbinstall.php file from your installation directory. UPGRADE FROM EARLIER VERSIONS @@ -44,10 +45,9 @@ BLANK PAGES IN TIME TRACKER If you see a blank page in when trying to access Anuko Time Tracker it may mean many things, among others, such as: - * MySQL extension for PHP not installed or not working. * Time tracker database not created. * Access (login / password) to the database is not configured properly in config.php. - * MySQL service is down. + * MySQL service is down. * On UNIX systems - no full access rights for catalog WEB-INF/templates_c/ (chmod 777 templates_c). You need to thoroughly test each and every component to make sure they work together nicely. -- 2.20.1