Installation Manual
Version 5.0
LogicalDOC 5.0 Installation Manual
© 2009 Logical Objects srl, via Carlo Marx 131 – 41012 Carpi Italy. All rights reserved.
http://www.logicalobjects.com
This document is subject to change without notice.
License
This work is licensed under a GNU Free Documentation License 1.2.
http://www.gnu.org/licenses/fdl-1.2.txt
Disclaimer
Documentation is provided 'AS IS' and all express or implied conditions, representations
and warranties, including any implied warranty of merchantability, fitness for a particular
purpose or on-infringement, are disclaimed, except to the extent that such disclaimers
are held to be legally invalid.
Contents
Contents
1 PREREQUISITES...........................................................................................4
2 INSTALLATION..............................................................................................4
WINDOWS...........................................................................................................4
LINUX.................................................................................................................5
Check Java Runtime....................................................................................5
Prepare the Database..................................................................................5
Installation with the Graphical Setup...........................................................6
Installation without Graphical Setup............................................................7
Post-installation............................................................................................8
Configure Open Office as a service.............................................................9
3 UNINSTALLATION........................................................................................9
WINDOWS...........................................................................................................9
LINUX.................................................................................................................9
LogicalDOC Installation Manual 12/29/2009
Prerequisites
1 Prerequisites
LogicalDOC is certified for execution on the following operating systems:
• Windows 2000 and followings
• Windows Server 2003 and followings
• SuSE Linux 10.0 and followings
• Max OS X 10.4 and followings
The minimum required hardware is:
• CPU: Intel 2.0Ghz or equivalent
• RAM: 1GB dedicated
• Disk: at least 80GB of free space
• Network: 100/1000 Gb/s
Software:
• SUN Java JRE 1.6.0 or later (do not use runtimes from other
vendors)
• Open Office 3.0 or later (required by pdf conversion feature)
• MySQL 5.0 or later (only for Linux and Mac installation)
The installation itself will take few minutes, but we suggest to plan a couple of
hours.
2 Installation
LogicalDOC can be installed using the proper setup program downloadable
from: http://dist.logicaldoc.com
In this page all setup programs are listed, each one dedicated to a particular
operating system.
2.1 Windows
For Windows the setup is: logicaldoc-windows-jvm-installer-<rel>.exe
This one contains even the Java runtime, you can use this setup if your
system doesn't have a JRE 1.6 currently installed on your system.
To install LogicalDOC double-click on the executable file and follow the setup
steps. Leave all settings as default or change them at your will.
For database selection we recommend to choose External Database, and
leave the setup to install it's private MySQL instance.
At the end of installation, point the browser to http://localhost:8080/logicaldoc
and enter with credentials admin / admin.
Note: on Windows Vista launch the setup as Administrator
LogicalDOC Installation Manual 12/29/2009 4
Installation
Important: Make sure to not to have installed a JRE 1.5, before installing
LogicalDOC. If this is the case, in order to avoid problems and conflicts,
install a fresh JRE 1.6 before launching LogicalDOC setup.
2.2 Linux
On Linux the MySQL automatic installation is not provided as for Windows. So
make sure to have a MySQL 5.0(or later) up and running in your system.
On Linux we suggest to install and execute LogicalDOC as root user, to make
sure to log-in as root before continuing, since this guide assumes you perform
all thing as root. Also since the LogicalDOC setup is a graphical application,
you need to launch it from KDE or GNOME.
Note: An alternative procedure GUI-less will be described later
2.2.1 Check Java Runtime
To check the presence of the Java runtime, open a shell and execute the
command: java -version
you must see something like this: java version “1.6.0_01”
If you do not have it installed, please download the RPM from the Sun
website: http://java.sun.com
Once correctly installed the JRE, make sure to have an environment
JRE_HOME pointing to your JRE installation.
Type the command: echo $JRE_HOME
you must see something like: /usr/java/default
Note: It is strongly recommended to use official JRE releases from SUN,
since the usage of runtimes from other vendors will invalidate the product
support.
2.2.2 Prepare the Database
In order to setup a production system you have to prepare a MySQL database
where LogicalDOC will store all data.
In order to perform this step, make sure to have a MySQL up and running, so
execute the command: /etc/init.d/mysql status
Default settings
LogicalDOC requires you to configure your MySQL installation to bes fit the
needs of a professional DMS. So edit your current my.cnf configuration file,
find the [mysqld] section and append the following settings:
default-character-set = utf8
LogicalDOC Installation Manual 12/29/2009 5
Installation
default-storage-engine = INNODB
This sets the encoding to UTF-8 and the default storage engine to the
INNODB with transactions support.
Setting Password for MySQL Root User
Execute the following commands at a shell prompt:
/usr/bin/mysqladmin -u root password 'password'
Creating logicaldoc User Account
Now we need to create a database user for logicaldoc. So connect to mysql
prompt typing the command:
/usr/bin/mysql -u root -ppassword
Execute the following commands at the mysql prompt:
CREATE USER logicaldoc;
SET PASSWORD FOR logicaldoc@"%"=PASSWORD('password');
Adding Grants
Execute the following commands at the mysql prompt:
GRANT ALL PRIVILEGES ON logicaldoc.* TO logicaldoc@"%" identified by
'password';
Creating the database
Execute the following commands at the mysql prompt:
CREATE DATABASE logicaldoc;
Now we have an empty database called 'logicaldoc' with a user 'logicaldoc'
that can access it using password 'password'.
You can exit the mysql prompt(command \q) and go ahead.
2.2.3 Installation with the Graphical Setup
The Linux setup is: logicaldoc-cross-platform-installer-<rel>.jar
Download it and execute the command from command line:
java -jar logicaldoc-cross-platform-installer-<rel>.jar
This command launches a the graphical setup program. Follow the setup
steps. Leave all settings as default or change them at your will, but this guide
assumes that the installation folder is /LogicalDOC.
LogicalDOC Installation Manual 12/29/2009 6
Installation
When the setup asks for database, choose External Database for a
production system. Than in the next panel, set your connection parameters
and in particular use logicaldoc as user and database schema and digit your
password as specified earlier during account creation.
2.2.4 Installation without Graphical Setup
The Linux setup is: logicaldoc-cross-platform-installer-<rel>.jar
Download it and execute the following commands command from command
line:
unzip logicaldoc-cross-platform-installer-<rel>.jar -d tmp
mkdir /LogicaLDOC
tar -zxf tmp/LogicalDOCJex.tar.gz -C /LogicalDOC
cd /LogicalDOC/tomcat/webapps/
unzip logicaldoc.zip -d logicaldoc
At this point you have a complete LogicalDOC distribution in the directory
/LogicalDOC.
LogicalDOC Installation Manual 12/29/2009 7
Installation
To start the execution type the following commands:
export LOGICALDOC_HOME=/LogicalDOC
cd $LOGICALDOC_HOME/bin
./logicaldoc.sh start
Now LogicalDOC is in execution and you have to perform the first setup, just
point your browser to: http://localhost:8080/logicaldoc/setup
If the browsers ask you the credentials, use admin / admin to access to the
Web Setup Procedure.
In the first step, select the repository folder as follows:
When you are asked to choose the database, select the External Database:
Than in the next panel, set your connection parameters and in particular use
logicaldoc as user and database schema and digit your password as specified
earlier during account creation.
2.2.5 Post-installation
To start LogicalDOC at server bootstrap you need to copy the startup script
into your system initialization directory so execute the command:
cp /LogicalDOC/bin/logicaldoc /etc/init.d
Then edit the file /etc/init.d/logicaldoc setting the environment variable
LOGICALDOC_HOME with the installation path: vi /etc/init.d/logicaldoc
Save the file and execute the command: chkconfig --add logicaldoc
Execute the command: /etc/init.d/logicaldoc start
LogicalDOC Installation Manual 12/29/2009 8
Installation
Now you can access the program using the browser, pointing it to
http://localhost:8080/logicaldoc. Use the account admin with password admin
to enter the first time.
Environment variables
LogicalDOC and above all some external tools like the backup procedure
requires the LOGICALDOC_HOME variable correctly set.
Execute the command: echo $LOGICALDOC_HOME
you must see something like this: /LogicalDOC
If it is not the case, please provide the user environment with this variable(for
example you can set it in .bashrc)
2.2.6 Configure Open Office as a service
As last step, if you want to make LogicalDOC capable of pdf conversions, you
need to launch your Open Office as a daemon.
In order to the job, create the shell script /etc/init.d/logicaldoc with the
following content:
#! /bin/sh
### BEGIN INIT INFO
# Provides: openoffice
# Required-Start:
# Should-Start:
# Required-Stop:
# Default-Start: 3 5
# Default-Stop: 0 1 2 6
# Description: Open Office Daemon
### END INIT INFO
soffice -headless -accept="socket,host=127.0.0.1,port=8100;urp;"
-nofirststartwizard
Then type the command: chkconfig –add openoffice
3 Uninstallation
3.1 Windows
Execute the program located at: C:\LogicalDOC\Uninstall.exe
At the end of the procedure delete the directory C:\LogicalDOC
3.2 Linux
Shutdown the service: /etc/init.d/logicaldoc stop
Delete the file /etc/init.d/logicaldoc
Delete the directory /LogicalDOC
Remove the variable LOGICALDOC_HOME from the environment
LogicalDOC Installation Manual 12/29/2009 9
