Introduction

Callimachus includes a setup script that is used to intialize a new and upgrade an existing Callimachus instance. Follow the procedure below to install the latest Callimachus distribution.

Procedure

Step Action
1

Check if a Java Development Kit (JDK not just a JRE) is installed and that the version is correct. Callimachus requires different JDK versions depending on what version of Callimachus you are using. If you are using:  

  • Callimachus 1.1.1 and earlier requires JDK 1.6 (1.6.0_20 or higher, but not 1.7)
  • Callimachus 1.1.2 can work with either JDK 1.6 (1.6.0_20 or higher) or 1.7
  • Callimachus 1.2 and later require JDK 1.7

From the command prompt issue the command: java -version and javac -version to see what version is locally installed. You can also issue the command: which java to see the directory where it is installed. Install a Java JDK if it is not yet installed.

NB: Callimachus will not work with JDK version 8 at this time.

2

Download the .zip file for the latest version of Callimachus from http://callimachusproject.org and unzip it into an empty target directory.

3

Copy the file etc/callimachus-defaults.conf to a new file called etc/callimachus.conf. Open etc/callimachus.conf in a text editor and make the following changes as necessary:

  • Remove the '#' before the PORT and ORIGIN variables and edit them to match the appropriate values for your system. The value of ORIGIN must match exactly what will be in the browser's address bar before the path. Set the PORT variable to 80 if you want to be able to access Callimachus without a port number in the URL. Warning: After the setup script has been run, the ORIGIN variable cannot be changed without reinstalling Callimachus.
  • Create a file called mail.properties in the etc/ directory to allow for mail functionality within Callimachus. 
4

Run the Callimachus setup script from a console to initialize Callimachus.

For Mac and Linux Desktop users:

  • Run bin/callimachus-setup.sh and follow any prompts.

For Linux Server users (as root):

  • Run bin/callimachus-install.sh
  • Run bin/callimachus-setup.sh

For Windows Users:

  • Run bin/callimachus-setup.bat and follow any prompts.

Note: In Callimachus 1.1, instead of being prompted for a password during the setup script, you will be provided a URL at the end of the setup script. Once you have started the server, access that URL and setup your initial password. If you lost the URL (and setup mail.properties correctly) you can receive a temporary password via email using the "Need another password?" button on the sign in page.

5

Setup your initial user account and password by copying and pasting the URL provided at the end of the setup script into the browser. If your operating system supports it, you are have a local windowing system and a Web browser, the setup script will open your default browser to the login screen so you won't need to copy and paste the URL.

The setup URL will take you to the login screen:

Initial user login screen

You will then be asked to create a username and password for the initial user:

Initial user sign in

Some things to know:

Note: You should set up your initial user right away.  Run the setup script again if your initial user invitation expires.

Note: To stop the server at any time, run bin/callimachus-stop.sh (Mac/Linux) or bin/callimachus-stop.bat (Windows)

Congratulations, you've installed Callimachus succesfully! If you think something is not working correctly or some part of the installation process has gone wrong, please post to the discussion group.