XSBR System Documentation: Operation

This section explains the system requirements and directory structure of the XSBR system, as well providing installation instructions and post installation configuration instructions. XSBR is basically a number of Python CGI scripts that generate dynamic webpages.

System Requirements

Requirement	Comment
Hardware	A machine capable of running Apache HTTP Server and dealing with the number of uses / size of resources you plan to support.
Operating System	Any operating system which that can run a Apache HTTP Server and the Python programming language. This is pretty much every OS out there.
WebServer	Apache HTTP Server version 1.3 or version 2.0. XSBR may also be run using Internet Information Server (IIS) that comes with Windows Server systems but XSBR has never been tested with IIS.
Scripting language	XSBR using the Python programming language. The system should work with any version above 2.0.

Requirement

Comment

Hardware

A machine capable of running Apache HTTP Server and dealing with the number of uses / size of resources you plan to support.

Operating System

Any operating system which that can run a Apache HTTP Server and the Python programming language. This is pretty much every OS out there.

WebServer

Apache HTTP Server version 1.3 or version 2.0. XSBR may also be run using Internet Information Server (IIS) that comes with Windows Server systems but XSBR has never been tested with IIS.

Scripting language

XSBR using the Python programming language. The system should work with any version above 2.0.

Directory Structure

annotationform.py

collectionman.py

collectionpage.py

configManager.py

delete.py

descriptive.py

docs

index.html
introduction.html
operation.html

style.css

fieldQuery.py

loginChecker.py

loginpage.py

presentationpage.py

presgen.py

resource.py

rights.py

rightsChecker.py

schemaman.py

searcher.py

searchpage.py

tribalcarepage.py

upload.py

userman.py

web-config.xml

Installation

Copy all the Python CGI scripts to a xsbr directory under your cgi-bin directory.

Copy the ikm directory containing the images and presentations to your htdocs directory.

The first line of each python script contains a path to where the python interpretor can be found. This will have to be ajusted to your particular system: e.g. for Windows #!C:\Python23\python.exe and Linux/Unix #!/usr/bin/env python .

Ensure that all the Python scripts have the correct permissions (typically world executable) to run.

Ensure that the media and metadata directories (see section below) have correct permissions for uploading and viewing media items and medatata documents.

Configuration

The web-config.xml file (See Directory Structure & Files) is provided to record configuration settings.

The following elements must be set for your particular installation:

schema: path to the XML file that defines the rights data model, default schema may be used.

users: path to the XML file that contains user profiles.

metadata-dir: default location to save XML metadata files, normally the metadata directory.

media-dir: default location to look for media files.

*-extns: list of extensions for different media formats

web-config.xml

<?xml version="1.0" encoding="UTF-8"?&g
<config>
  <schema>/var/www/html/ikm/xml/schema.xml</schema>
  <users>/var/www/html/ikm/xml/users.xml</users>
  <metadata-dir>/var/www/html/ikm/metadata</metadata-dir>
  <media-dir>/var/www/html/ikm/media</media-dir>
  <http-access>http://www.myserver.org/ikm/media</http-access>
  <http-proxy>http://proxy.myserver.org</http-proxy>
  <text-extns>txt html text</text-extns>
  <image-extns>jpg jpeg jpe png tiff tif gif bmp</image-extns>
  <audio-extns>mp3 avi wav au</audio-extns>
  <video-extns>mpg mpeg</video-extns>
</config>

Example of web-config.xml configuration file