How to install Zuul?
Zuul is a web application. This means you need a server that runs Zuul, and a browser to access Zuul. If you know what these words mean and how to deploy a Java web application in a servlet container then the information on this page is probably all you need. Otherwise, see here.
System Requirements
You need the following software to be installed on your computer:
- A servlet container such as Apache Tomcat (http://tomcat.apache.org/). Zuul was developed and tested on Apache Tomcat 6.0.
Installation Process
To install Zuul three steps are necessary: download Zuul, configure Zuul, and deploy Zuul. In the following each step is described in more detail.
Note: if your Tomcat is configured to unpack deployed war-files, you can also first deploy Zuul and then configure it by editing the files listed in the "Configure" section below in the unpacked folder.
Download
There are two ways of getting Zuul, check out its code from the repository or download the latest release. It is recommended to use the latest release.
You can download the latest release of Zuul here.
The latest version of the source code of Zuul can be checked out using Subversion.
Configure Zuul
There are three settings that need to be configured before deploying Zuul: path to the database files, admin users, and the path to Zuul's file storage. If you downloaded the latest release, rename it from zuul-vX.Y.Z.war to zuul.zip and unzip the downloaded file. Then do the following.
db4o-config.xml
To configure the path to the database files, open the file db4o-config.xml that is located in the folder WEB-INF/spring. In the XML file find the section that defines the database files paths and replace the value for "databasePath" with the full path to the folder where the database files should be stored. You should do that for three files. Make sure that you keep the file names in the end (e.g. users.db). Also, ensure that the database folder is modifiable by the servlet container.storage.properties
To configure the path to the folder in which Zuul stores uploaded folders, open the file storage.properties located in WEB-INF/classes/conf. Add the path to a folder for Zuul to store uploaded files (modify the italic part). E.g. OSX: /yourhomedir/Desktop/zuul/files, or Windows: \\C:\\yourhomedir\\zuul\files
_storage_path=/path/to/zuul/storage/files
spring-security.xml
To configure the admin password open the file spring-security.xml in the folder WEB-INF/spring and change it as needed. The relevent code is around line 47. You can add more admin accounts by adding additional user tags:
Deploy Zuul
To deploy Zuul first create a war-file from the modified code and then deploy it in your servlet container. If you update an existing Zuul installation, make sure to restart your servlet container. Otherwise the database connection might cause problems.
If you downloaded the latest release of Zuul as a war-file (and unzipped it) and if you are using a Unix-based system, you can create a war-file by navigating into the unzipped folder using a terminal. Then type