Installation

Kunagi is a Java web application. You can deploy it to your favourite web application server on your favourite operating system, running Java 6. For the majority of servers, all you have to do, is to copy the current kunagi.war to the webapps directory.

Installation on Ubuntu

Download the debian package kunagi.deb package from kunagi.org/download.html and install it.

For german users, there is an article on ubuntuusers.de.

Installation on Windows

Download the kunagiXX.exe starter from kunagi.org/download.html and run it. It will download the latest Kunagi web application and start it with an embedded Tomcat.

Installation with Tomcat

If you don't have a web application server yet, here is an example, how to install Kunagi with Apache Tomcat.

1. Install Sun Java 6 and verify by executing the command java -version.
2. Make sure that an environment variable JRE_HOME (in case of Java JRE) or JAVA_HOME (in case of SDK) is set to the Java installation path.
3. Download Tomcat from tomcat.apache.org .
4. Extract the downloaded Tomcat archive.
5. Download Kunagi from kunagi.org/download.html and copy the .war file to the webapps directory of your Tomcat.
6. Make sure, the working directory or the home direcotry of the user, which is running Tomcat is writable for him.
7. Start Tomcat by executing the startup.bat (Windows) or startup.sh (Linux) script from the bin directory.
8. Check Tomcat and Kunagi log file logs/catalina.out for errors.

By default, Tomcat listens on port 8080. So you can access Kunagi by opening http://localhost:8080/kunagi/.

Depending on your operating system or distribution, some of the steps might be unnecessary if Tomcat is installed via an installation wizard (Windows) or software repositories (Linux).

Upgrade

Ubuntu users can just download the new .deb package and install it.

Windows users who are using the kunagi.exe starter will get the new version automatically.

Otherwise:

1. Stop your web application server (Tomcat).
2. Backup the data directory.
3. Replace the old kunagi.war with the new one.
4. Start your web application server.

Backups

Kunagi stores all data as XML files in the data directory kunagi-data. The full path is shown on startup in the logs and on the Administration -> System configuration page in Kunagi.

To create a backup, copy, zip or rsync the data directory.

To restore a backup, replace the contents in the data directory with your backup contents.

Generating websites for projects

Kunagi can help you create websites for projects. It uses Velocity templates to generate the pages.

1. Create a website directory on the same server, where Kunagi is installed and set up your web server to serve this directory.
2. Give the user, who is running the Kunagi web application server write permissions to this directory.
3. Set the path to the website directory in Kunagi, Administration -> Project administration -> Homepage -> Homepage directory.
4. Create a subdirectory called velocity inside of the website directory and put your Velocity templates there.

Every file inside the velocity subdirectory, which ends with .vm will be interpreted as a template. Kunagi reads this template, merges it with the project data and writes it back directly to the website directory into a file named the same as the template, but without the .vm suffix. There are some special cases for entity templates like iss.vm or sto.vm. These are processed not once, but for every entity. By creating the VM_global_library.vm template file, you can define macros and reuse them in all other templates.

Take a look into our velocity templates on GitHub for examples and into the Velocity user guide.