Callimachus
  • Home folder
  • Recent changes
  • About Callimachus
  • Getting started
  • Send feedback
  • Download Docbook
  • What links here
  • Related changes
  • Permissions
  • Introspect resource
  • Print this page
  • Account
  • Sign out

    • Getting started with Callimachus

    Essential documentation

    There are three documents that will help you get up and developing quickly. They include:

    1. Getting Started with Callimachus

    2. Callimachus for Web Developers

    3. Meeting Notes Tutorial

    A. Installing Callimachus

    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 uses  JDK 1.6 (1.6.0_20 or higher, but not 1.7)

    From the command prompt issue the command: java -version and javac -version
    2

    Install a Java JDK if it is not yet installed.
    3

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

    Copy the file etc/callimachus-defaults.conf to a new file called etc/callimachus.conf.

    • If needed, edit the PORT and ORIGIN variables inside callimachus.conf 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. Warning: After the setup script has been run, the ORIGIN variable cannot be changed without reinstalling Callimachus.
    • Remove the '#' before FULLNAME= and add your full name in double quotes.
    • Remove the '#' before EMAIL= and add your email address.
    • Remove the '#' before USERNAME= and add an alphanumeric username in lowercase of your choice.
    • Also create a file called mail.properties in the etc/ directory to allow for mail functionality within Callimachus. 
    5

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

    For Mac Users:

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

    For Linux Users:

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

    For Windows Users:

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

    Note: In Callimachus 1.0, 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.
    6

    Run the Callimachus start script to start the server.

    For Mac/Linux Users:

    • Run bin/callimachus-start.sh

    For Windows Users:

    • Run bin/callimachus-start.bat

    By default the Callimachus server is accessed typing http://localhost:8080 into your browser unless you have changed the authority in etc/callimachus.conf.
    7

    Setup your initial user account and password by copying and pasting the URL provided at the end of the setup script into the browser. The server has now started and Callimachus can be used.

    Note: To stop the server at any time, run bin/callimachus-stop.sh (Max/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.

    B. Browser support

    This describes the browsers that are supported by Callimachus.

    Supported browsers

    Calliamachus works best with the most recent versions of

    • Google Chrome
    • Firefox

    Partially supported browsers

    Callimachus provides partial support for the following

    Browser Issue
    Safari
    • Drag and drop from the local file system into browser is not supported.
    Internet Explorer 8
    • Page elements may lay out incorrectly on some pages.
    • Syntax highlighting within text editor is not supported.
    • When uploading a CSS or JS file, the browser will ask if you want to save or open file. Just ignore this prompt, the file has uploaded correctly.
    • Cannot upload files in .docbook format. Docbook documents must be created within Callimachus.
    • Drag and drop from local file system into browser is not supported.
    • Client-side validation when creating a concept is not functioning. Be careful to always enter a Label for concepts.
    Internet Explorer 9
    • Text cannot be typed into the text editor for Books, Graph documents, Named Queries, Pages, Pipelines, Scripts, and Styles. The current workaround is to create them outside of Callimachus and upload them, but that will not work for Books.
    • When uploading a CSS or JS file, the browser will ask if you want to save or open file. Ignore this prompt, the file has uploaded correctly.
    • Cannot upload files in .docbook format. Docbook documents must be created within Callimachus.
    • Drag and drop from local file system into browser is not supported.
    • Client-side validation when creating a concept is not functioning. Be careful to always enter a Label for concepts.

    Unsupported browsers

    Callimachus does not support

    • Internet Explorer 6
    • Internet Explorer 7

    C. Adding users

    To add a new user, an existing user who is part of the "admin" group must

    1. Navigate the their primary group edit page.
    2. Invite a new user using the icon in the Members field.
    3. Complete a user invitation form for the person to add.
    4. Save the primary group.
    5. Add the user to other User Groups as needed by clicking on the Members icon and using the lookup search box in the dialogue.

    The new user will recieve an email invitation with a registration link and instructions on how to log in.

    D. Starting and stopping the Callimachus server

    Purpose

    This describes how to start and stop the Callimachus server.

    Procedure

    Step Action Example
    1 From the command prompt navigate to the Callimachus directory. ../3RoundStones/callimachus-1.0
    2 Start the server by running the callimachus-start.sh script from the /bin directory. bin/callimachus-start.sh
    3 Stop the server by running the callimachus-stop.sh script. bin/callimachus-stop.sh

    Note: Always stop the Callimachus server before starting it again.

    E. Starting the Callimachus client

    Instruction

    To start the Callimachus client in your browser enter: http://localhost:8080/

    Note: This assumes you are running the Callimachus server on the same machine you are accessing it in your browser. Replace localhost with the host name and if applicable, the port number of the server you are using.

    F. Sample Callimachus applications

    Callimachus applications are packaged as CAR files, and can be installed by importing the contents of the sample application into a newly created folder. 

    Once a user account is created on a new installation

    • click on the home folder menu entry

    • in the resource menu, click on the new folder icon, and then

    • provide a folder name. 

    Once an empty folder is created open its edit tab and choose the import link in the sidebar. Provide the CAR file in the form and submit.

    This application ... Demonstrates ...
    HelloWorld view template association with a class member resource
    School Ward controlled form selection using concepts in checkboxes and drop downs
    Meeting Notes container resources
    Directory create and edit forms with embedded resources

    G. Callimachus Support

    3 Round Stones offers commercial support and private virtual cloud hosting for enterprises running Callimachus.

    Commuity support may be access through our mailing list.