OS Support

It's possible to install ivata groupware on most operating systems which support Java, but we have tested it works on the following:

• Debian Woody
• Fedora Core 3
• Fedora Core 2
• SuSE 9.2 (FTP version)
• SuSE 9.1 (FTP version)
• Windows XP

Windows Support

On Windows platforms, we use the excellent hMailServer for mail and to check users. The install process was tested on Windows XP, but it should be possible to install on other Windows flavors. If you try this and have success/failure, please, please let us know.

GNU/Linux Support

On supported GNU/Linux platforms, we use sudo scripts to add/remove users. The script (setupSudo.pl) will help you set this up.

Other flavors of GNU/Linux or UNIX

In the past, we've also had ivata groupware running happily on Red Hat, Debian (Sarge and Potato) and Gentoo.

If you install Perl and the other packages listed below, these instructions should really apply to any flavor of UNIX. Please do let us know how you get on.

Requirements - Windows

To install ivata groupware on Windows, you need the following:

• Windows Operating System
• Administrator access
• Java JDK 1.4 or higher
• hMailServer
• JBoss 3.x or Resin or Tomcat 4.x or higher

Installing ivata groupware - Windows

Remember to download and install the Java JDK, App Server, and hMailServer from the above sources before installing ivata groupware!

After that, the following steps will get you up and running.

1. Become an Administrator user (member of the Administrators group) on your machine.
2. Create a domain in hMailServer, and a single user called 'ivata@{the domain}'. Set a password for this user.
   
   You must call this admin user 'ivata@{the domain}' in hMailServer! When you log into ivata groupare for the first time, you must use the user name ivata, and the password you set in iMailServer.
   
   The domain name must be a valid host name accessible from the local host - if necessary, add it to c:\WINDOWS\system32\drivers\etc\lmhosts with an editor like notepad:

   notepad c:\WINDOWS\system32\drivers\etc\lmhosts
   

   (If the file doesn't exist, create a new one)
   
   Add an entry to the file like this:

   127.0.0.1 mydomainname
   

   (replacing mydomainname with the domain name you set up in hMailServer).
3. Unzip the file ivatagroupware-install-{version}-win32.zip to a convenient place, like C:\install. To unzip the file, use a program like WinZip, or you can use the jar program from the Java JDK you should already have downloaded. For example, enter these commands into a command prompt (DOS) console:

   c:
   mkdir install
   cd install
   {\path\to\java\bin\}jar -xvf {\path\to\download\}ivatagroupware-install-0.10-win32.zip
   

4. Copy the jcom.dll file to a location on your path For recent versions of Apache Tomcat you must copy the file to the bin directory of your tomcat installation (probably something like C:\Program Files\Apache Software Foundation\Tomcat xx\bin). On other app servers, copy to the place where other libraries or binaries are stored.).

   c:
   cd c:\install\ivatagroupware-0.11
   copy jcom.dll "C:\Program Files\Apache Software Foundation\Tomcat 5.5\bin"
   

5. Copy the WAR file to the deploy directory of your app server. Since most app servers use the WAR file to generate the program URL, it is a good idea to rename the WAR so that it does not include the version number.

   c:
   cd c:\install\ivatagroupware-0.11
   copy ivatagoupware-0.11.war c:\Program Files\Apache Group\Tomcat4\webapps\ivatagroupware.war
   

6. The database can be set up automatically, if you use Hypersonic SQL. If you want to you another DB, copy the JDBC drivers to the app server path (and check out the section at the end of this page).
   
   For example, using Tomcat 4, copy the driver JAR file to directory common/lib in the tomcat directory.
7. Restart your application server, and browse to the ivatagroupware directory, e.g. http://localhost:8080/ivatagoupware. Make sure you have JavaScript enabled in your browser first!
   
   The first time, you will be shown a setup screen. Enter the JDBC parameters (or leave the defaults, to create a DB automatically), and choose the email domain name you setup in hMailServer.
8. Note if you need to run this setup program again later (for example, to use a different database), simply login to the site, and browse to the address /setup.action, e.g. http://localhost:8080/ivatagroupware/setup.action if you called the WAR file ivatagroupware.war.

Requirements - UNIX-style OS

You need all of the following installed and running:

• Java JDK 1.4 or higher
• Courier IMAP **prefered** or UW IMAP or Cyrus IMAP
• JBoss or Resin or Tomcat 4.x or higher
• Perl 5.6 or greater
• Perl modules: Bundle::Expect - see below, and Term::ReadKey
• sudo

Installing Bundle::Expect for Perl

You will need to install the Bundle::Expect Perl module. All versions of Linux we have tested had packages for this on CD, or we could find packages via the web (e.g. rpmseek.com).

If your OS supplier doesn't provide perl Expect as a package, these generic instructions will show you how to install Bundle::Expect over the net. Of course, you'll need Perl installed before you start ;-)

Then enter the following into a terminal:

perl -MCPAN -e shell

The first time you do this, it will ask several questions and ask about download options, etc. Work through the questions and, eventually, you will be presented with a cpan> prompt. Enter 'install Bundle::Expect; at the prompt:

install Bundle::Expect

Debian Notes

You need to install Perl and the necessary modules like this:

apt-get install perl perl-modules libterm-readkey-perl libexpect-perl

Using Debian Package tomcat4

There is a tomcat4 package which comes with Debian, however I found there were some issues with it. If you use that you will need to change the attribute unpackWars to true. Look for a line like this:

<Host name="localhost" debug="0" appBase="webapps" unpackWARs="false">

<Host name="localhost" debug="0" appBase="webapps" unpackWARs="true">

Installing ivata groupware - UNIX-style OS

After you've completed the pre-install steps above for your OS, follow these steps.

1. Become root on your machine.

   su - root
   

2. Extract the file ivatagroupware-install-{version}.tar.gz to /usr/local. For example:

   cd /usr/local
   gunzip -c /path/to/ivatagroupware-install-0.11.tar.gz | tar -xv
   

3. Create a symbolic link. By default the ivata groupware install package includes a verson number. You need to create a link like this:

   cd /usr/local
   ln -sf ivatagroupware-0.11 ivatagroupware
   

4. Check/change the settings in the text file setupSudo.config.

   cd /usr/local/ivatagroupware
   vi setupSudo.config
   

   The script expects you have a user you use to run your app server. You should make sure this user is set in setupSudo.config (change the value of USER_APP_SERVER), and the user exists on your system. For example:

   useradd tomcat
   

5. Once that's done, run the script

   cd /usr/local/ivatagroupware
   perl setupSudo.pl
   

6. Create the admin user ivata on your local IMAP server:

   useradd ivata
   

   (The commands you use will vary, depending on the IMAP server you installed.)
   
   You must call this admin user 'ivata' in your IMAP server!
   
   Set the password for this user on the local IMAP server:

   passwd ivata
   

   This is the user name and password you will use to log into ivata groupware the first time. On some systems (e.g. Courier IMAP), you also need to create a maildir/mailbox for this user:

   maildirmake /home/ivata/Maildir
   chown -R ivata:ivata /home/ivata
   

7. Copy the WAR file to the deploy directory of your app server. Since most app servers use the WAR file to generate the program URL, it is a good idea to rename the WAR so that it does not include the version number.

   cd /usr/local/ivatagroupware
   cp ivatagoupware-0.11.war /usr/local/tomcat/webapps/ivatagroupware.war
   

8. The database can be set up automatically, if you use Hypersonic SQL. If you want to use another DB, copy the JDBC drivers to the app server path (and check out the section at the end of this page).
   
   For example, using Tomcat 4, copy the driver JAR file to directory common/lib in the tomcat directory.
9. Restart your application server, and browse to the ivatagroupware directory, e.g. http://localhost:8080/ivatagoupware if you called the WAR file ivatagroupware.war. Make sure you have JavaScript enabled in your browser first!
   
   The first time you visit the site, you will be shown a setup screen. Enter the JDBC parameters (or leave the defaults, to create a DB automatically), and enter the full path to the ivata groupware scripts directory (/usr/local/ivatagroupware).
   
   After this, you will be presented with the login screen where you can login using the user name and password you set earlier.
10. Note: if you get problems logging into ivata groupware for the first time, it is likely that the user ivata is not set up in the IMAP mail server. Test using another IMAP client (such as Thunderbird) and check the mail logs (usually /var/log/mail.xxx) for errors.
11. Note if you need to run this setup program again later (for example, to use a different database), simply login to the site, and browse to the address /setup.action, e.g. http://localhost:8080/ivatagroupware/setup.action if you called the WAR file ivatagroupware.war.

Database Support

The ivata groupware package now contains Hypersonic SQL and can create a working database on the file system for you. The setup screen will start automatically the first time you start ivata groupware and guide you through this process. This means you don't need any database system at all before you get started.

If you do want to use a different database system, however, you'll be happy to hear ivata groupware doesn't contain vendor-specific SQL code and will work with any RDBMS supported by its persistence layer, Hibernate - for a full list, look here.

For some of these, we have created scripts to create a start schema and data. To use one of these, create a blank database, then use the scripts called schema-current.sql and data-current.sql in turn, from the directory shown for your DB below: