Synergeia 2.0 
Basic Support for Collaborative Learning & Knowledge Building 

============================================================================
The Synergeia software contains of two parts:
o  the asynchronous part - BSCL (Basic Support for Collaborative Learning)
o  the synchronous part - MapTool and InstantMessaging
BSCL is part of the BSCW software and is copyright 2003 © Fraunhofer FIT 
and OrbiTeam Software GmbH, cf. license.txt (bscw@fit.fraunhofer.de, 
info@orbiteam.de). MapTool and InstantMessaging are copyright 
2003 © University of Murcia (skarmeta@dif.um.es).

This software is provided without guaranty and support.
============================================================================


Prerequisites:
==============

- Unix (Solaris, Linux) or Windows XP/2000

- Install Python 2.2 and Python Win32 Extensions (on Windows only).

- Install Java 1.4

- Install a Web Server, either Apache or IIS (on Windows only)

- Install an Elvin4 server (http://elvin.dstc.com)


Synergeia Installation:
=======================

The Synergeia software is delivered as a BSCW package. For installation
you have to upgrade a BSCW server to an Synergeia server.


- Install a new BSCW 4.1 server (BSCW 4.1.3 or above).


- Unpack the BSCL zip archive over the BSCW server directory


- Edit src/config.py and set at least the following variables:

MAY_REGISTER = [ 'register is not allowed' ]

REGISTER_DETAILS   = [ 'fullname', 'org' ]

SERVER_ROOT = 'http://<your.server>'

PACKAGES = [
	'../packages/BSCL',
]

SMTP_HOST = '<smtp.mail.host>'

SERVER_ADMIN = '<admin.email.addr>'

SERVER_ADMINS = ['<admin.userid>']

RESOURCES_PREFIX = '/bscl_resources/'

CREATE_SCRIPTS = ['bscl.cgi']

SCRIPTS = {
    '/bscl/':
	(None,            '../cgi', CREATE_SCRIPTS, SECURE_SCRIPTS),
    '/bsclpub/':
	('anonymous',     '../cgi', CREATE_SCRIPTS, SECURE_SCRIPTS),
}

Note: Use the userid of the server administrator only to adminster
the server, not to invite new user or create courses, because a server
administrator can do things which don't fit in the philosophy of 
registering new users in Synergia.

Note: If you want to provide a Logout-Function you have to activate 
the Cookie-Authentication via:

COOKIE_AUTHENTICATION = ('bscw_auth', None, 1200)


- Run the following bsadmin commands:

bsadmin index_page
bsadmin conf_apache
bsadmin conf_iis           (on Windows only)
bsadmin chkconfig
bsadmin update_bscl


- Register the system administrator and yourself, and set the system role 
to the teacher role. A Synergeia server have two system roles: teacher and
student. A teacher has special rigths, i.e.
- register other students or teachers
- to create courses and groups
- to help students, i.e. a teacher can change the password, the 
  details, the preferences or the profile of a student.
Students have only reduced rights.

bsadmin register -r <admin.email.addr> <admin.userid> <admin.passwd>
bsadmin sysrole <admin.userid> teacher
bsadmin register -r <your.email.addr> <your.userid> <your.passwd>
bsadmin sysrole <your.userid> teacher

Note: Use the userid of the server administrator only to adminster
the server, not to invite new user or create courses, because a server
administrator can do things which don't fit in the philosophy of 
registering new users in Synergia.


- Edit the file 'packages/BSCL/src/bs_config.py' and set:

ELVIN_SERVER = '<your.elvin.host>'
ELVIN_PORT   = <your.elvin.port>

Note: Don't use 'localhost' here.


- Edit the file 'packages/BSCL/MapToolUtils/mapToolServices.properties'
and set:

# BSCL
bsclServer = localhost                  host of the BSCL Server
bsclPort = 80                           port of the BSCL Server
bsclPath = /bsclpub/bscl.cgi            public path of the BSCL Server

# Elvin
elvinServer = localhost                 host of the Elvin server
elvinPort = 2917                        port of the Elvin server

Note: You may can use 'localhost' here.

To start the MapToolUtils you can use the scrip files, on Unix 'MapToolUtils.sh', 
on Windows 'MapToolUtils.bat'. You have to start the MapToolUtils every time
when the Synergeia server starts, i.e. on system start. 


- If you use Apache, configure the Apache server, i.e. add in httpd.conf

include <your.bscl.path>/apache.conf

and restart the Apache web server


- Open your web browser and connect to

http://<your.server>/bsclpub


- Access your workspaces and change with the menu item Options/Preferences
your profile to 'Expert'.


- Register new users with the menu item Main/Share/Register in you home 
directory.



Upgrade a Synergeia Server
==========================

You want to upgrade a Synergeia server with a new BSCW version:

- Upgrade the BSCW server as described 

- Run the bsadmin command:
    bsadmin update_bscl

You want to upgrade a Sysnergeia server with a new BSCL package:

- Backup the configuration files 'packages/BSCL/src/bs_config.py' and
'packages/BSCL/MapToolUtils/mapToolServices.properties'

- Unpack the BSCL zip archive over the BSCW server directory

- Restore the configuration files

- Run the bsadmin command:
    bsadmin update_bscl

- Restart the MapToolUtils