Chapter 10. Corelyzer server and plugin clients

Table of Contents

10.1. Server setup
10.2. Running the server
10.3. Running the administration client
10.4. Administrator commands
10.5. Admin commands reference table
10.6. Client plugin in Corelyzer
10.7. Example dataset file
10.8. Handy scripts
10.9. Some notes

Corelyzer server and plugin support was developed by Arun Rao, Yu-Chung "Julian" Chen and Sangyoon "James" Lee in 2006 for supporting ANDRILL MIS Project.

10.1. Server setup

Before starting the server, a few things must be prepared. First, the machine will need to have the Java Runtime Environment (JRE) 1.5 or greater. Second, a web-server must be running. Third, configuration files will need to be made.

Setting up the JRE and a web-server are beyond the scope of this document, but many resources are available on the Web to do so.

The server program requires two files. The first file contains the server settings and is specifically named “server-settings.txt”. This file contains only four lines and are as follows:

        <the base web address for all annotation pages>
	<the directory where the annotations are placed in the server for access>
	<the directory where the annotations are backed-up to>
	<the last time that the server performed a backup>
        <"backenabled" or "backupdisabled" to enable or disable data  backups>

Here is an example of that file:

NOTE: The second last line should be 0 when first starting the server. After which the server will automatically update that line every day.

The second file needed by the server is named “users.txt.” This file contains a listing of tuples that identifies a unique user. The tuple is (user name, real name, password). The first three lines of the file describe the user name, real name and password for the administrator of the server.

NOTE: It should be stated that permissions to this file should be setup so that only the administrator has read and write permissions to the file.

An example of the file can be as follows:

Arun G. Rao
Jason Leigh

Anytime a new user is going to be created, it is as easy as adding the user name, real name and password to the end of the file.