Installation Guide: Custom installation package for Unix
|
|
System Requirements
-
Java SDK
actiTIME requires Java 2 SDK 1.4.2 or higher which may be obtained at
http://java.sun.com/javase/downloads/index.jsp.
(This link points to the latest release of JDK. To get a previous JDK release use the following links:
J2SE 5.0 or
J2SE 1.4.2.)
actiTIME does not work with GNU Java that comes with some of linux systems. So please make sure that you have Sun JDK installed.
Please refer to the corresponding instruction describing how to install Sun JDK:
-
Apache Tomcat Application Server
Tomcat 6.0.17+ is not supported by the current version of actiTIME.
actiTIME requires Tomcat 4.1 or higher
which may be obtained at http://tomcat.apache.org/index.html
-
MySQL
If you want actiTIME to work with MySQL database, it will need MySQL 4.1.17+, 5.0.x or 5.1.x installed
(you can download MySQL installation package from http://www.mysql.com/downloads/index.html).
Please note that this version of actiTIME was not tested for compatibility with MySQL 6.0.
So it is not recommended to use it with the current version of actiTIME.
Installing actiTIME
-
Extract the installation package (for actiTIME Basic it is named actitime15_unix.tar.gz)
into a local directory. Subdirectory 'actitime'
will appear. Note that if you extract the archive into the
'<tomcat home>/webapps' you will only need to restart Tomcat server.
Otherwise you will have to configure Tomcat to make it able to run
actiTIME in another directory.
-
Enter the 'actitime' directory.
-
Create a MySQL user account with all privileges on the database that will
be created during the subsequent steps of installation. The default name
of this database is 'actitime'. You can choose any other name, but then
you have to specify this name as a parameter for the installation script.
-
Launch setup_mysql.sh.
setup_mysql.sh has the following launch format:
bash ./setup_mysql.sh [-mysqlhome <MYSQLHOME>]
[-username <USERNAME>] [-password <PASSWORD>]
[-host <HOST>] [-port <PORT>] [-dbname <DBNAME>]
where
<MYSQLHOME> - The path to the MySQL installation directory.
If not specified, setup_mysql.sh will ask for it when running.
Setup script will then search for MySQL executable file
at the following location: <MYSQLHOME> + "/bin/mysql".
<USERNAME> - the MySQL user name under which actiTIME will create and
use the database. If not specified, setup_mysql.sh will
ask for it when running.
<PASSWORD> - the password of user <USERNAME>. If not specified,
setup_mysql.sh will ask for it when running.
<HOST> - host name of the the server where MySQL server runs.
if not specified the local host is assumed.
Required if actiTIME has to use a remote MySQL database.
<PORT> - port on which MySQL server is running. If not specified
the default MySQL port will be used
<DBNAME> - the name of the database to be created. If not specified
'actitime' will be used as the database name.
NOTE: If the script finds the previous version of the actiTIME database then
it will back up the database to the actitime.mysql4.sql.backup_[current date] file.
-
Make necessary activities to the Tomcat application server if you want to
run actiTIME in non-default configuration (different port, virtual host etc.).
-
If you want to configure actiTIME to work via secure connections
(HTTPS) you can use Tomcat's facilities, but it will significantly
decrease the system performace since Tomcat's HTTPS module is built on
Java and requires considerable computational resources.
It is better to use Tomcat together with Apache web server
(http://httpd.apache.org/).
In this case secure requests will be processed without serious loss of
performance. Apache HTTP server will handle HTTPS requests, decrypt them
and then transfer decrypted data forwards to Tomcat. To make it work this
way see the Tomcat and Apache documentation.
-
If you want to run Tomcat with "-security" option, you will need to add
special permissions to $CATALINA_HOME/conf/catalina.policy file (or
$CATALINA_HOME/conf/tomcat.policy depending on the Tomcat version).
Set of permissions depends on Tomcat version and its configuration.
Examples of lines to add for Tomcat 4.1 version are listed below:
grant codeBase "file:<PATH>/actiTIME/-" {
permission java.lang.RuntimePermission "getClassLoader";
permission java.util.PropertyPermission "*", "read,write";
permission java.net.SocketPermission "<HOST>:<PORT>", "connect,resolve";
};
grant codeBase "file:<PATH>/actiTIME/WEB-INF/lib/*" {
permission java.lang.RuntimePermission "accessDeclaredMembers";
permission java.lang.RuntimePermission "getClassLoader";
permission java.util.PropertyPermission "*", "read";
};
where
<PATH> - path to the actiTIME directory or
'${catalina.home}/webapps' if actiTIME is installed
to webapps directory.
<HOST> - host name or IP of the the server where MySQL server runs.
<PORT> - port on which MySQL server is running (MySQL uses port 3306
by default).
-
Restart Tomcat. Now you can access actiTIME via web browser
(http://<server name>:8080/actitime if Tomcat is configured by
default and actiTIME is installed into the '<tomcat home>\webapps'
directory).
Login as user 'admin' with password 'manager' to configure system users.
Upgrading actiTIME from a previous version
We have done our best to ensure that your data stays safe. However it is strongly recommended
that you make a backup of actiTIME files prior to upgrading actiTIME.
It is also recomended that you backup actiTIME database.
Please refer to the backup instruction
You can install actiTIME Extended over your current version of actiTIME Basic.
-
Stop Tomcat server.
-
Copy the installation package file (for actiTIME Basic it is named actitime15_unix.tar.gz)
to the parent directory of the 'actitime' directory (directory where actiTIME is installed).
Unpack the file. This will overwrite the files of your existing actiTIME installation with their new versions.
-
Enter the 'actitime' directory.
-
Launch setup_mysql.sh.
setup_mysql.sh has the following launch format:
bash ./setup_mysql.sh [-mysqlhome <MYSQLHOME>]
where
<MYSQLHOME> - The path to the MySQL installation directory.
If not specified, setup_mysql.sh will ask for it when running.
Setup script will then search for MySQL executable file
at the following location: <MYSQLHOME> + "/bin/mysql".
Prior to updating database structure the setup script backups database and
saves data in a file in the 'actitime' directory. Name of the backup file is
actitime.mysql4.sql.backup_<YYYYMMDDhhmmss>.
Where <YYYYMMDDhhmmss> is date and time when script was run.
-
Delete all files from the Tomcat cache directory
<tomcat>/work/<Engine Name>/<Host Name>/actitime/
Where
<tomcat> is the directory where Tomcat is installed.
<Engine Name> - name of the Tomcat engine configured for your installation.
Usually is 'Standalone' or 'Catalina'.
<Host Name> - name of the virtual host
configured for your Tomcat installation.
-
Start Tomcat server.
User Documentation
After actiTIME installation is complete, the full HTML user documentation will be available
in the actiTIME interface in the 'Help & Support' menu.
Uninstalling actiTIME
-
Stop the Tomcat server.
-
If you would like to remove the actiTIME database with all the data,
enter the 'actitime' directory and execute command:
bash ./cleanup_mysql.sh. [-mysqlhome <MYSQLHOME>]
where
<MYSQLHOME> - The path to the MySQL installation directory.
If not specified, cleanup_mysql.sh will ask for it when running.
Cleanup script will then search for MySQL executable file
at the following location: <MYSQLHOME> + "/bin/mysql".
cleanup_mysql.sh completely deletes the database created during
installation.
-
Delete the 'actitime' directory and all its subdirectories.
|
