========================================================================================================================
					           G L O S S A R Y
					
							README
========================================================================================================================
						

Here is a basic outline of the installation process:

0)  Requirements

    GLOSSARY is primarily developed in Linux using Apache, MySQL and PHP (also sometimes known as the LAMP platform)
    
    The requirements for GLOSSARY are as follows: 
    
    Web server software				: most people use Apache, but GLOSSARY should work fine under any web server that supports
    						  PHP, such as IIS on Windows platforms. 
    PHP scripting language			: version 5.x.
    GD library for PHP				: library used to work on images
    PEAR with following packages
	- MDB2					: database library, see http://pear.php.net/package/MDB2 for more details
	- MDB2_Driver_mysql			: drivers to use MDB2 with mysql, see http://pear.php.net/package/MDB2_Driver_mysql for more details
	- HTML_Template_IT			: template used to separate content from logic, see http://pear.php.net/package/HTML_Template_IT for more details
    A working database server			: glossary has been tested only on mysql, but it should also work on other db. To try a different db type use the appropriate MDB2_Driver (http://pear.php.net/search.php?q=MDB2&in=packages&x=0&y=0)
    A shibboleth Service Provider (optional)	: only if you are planning to use shibboleth authentication

    
    If you want to run GLOSSARY on your own computer and all this looks a bit daunting, then follow this guide:
    
    http://www.apachefriends.org/en/faq-xampp.html and remember to install PEAR and the required packages.

1)  About PEAR

    PEAR is a framework and distribution system for reusable PHP components. 

    To learn how to install PEAR and its packages on your server please read the guide at http://pear.php.net/manual/en/installation.php

    To learn more about PEAR please visit http://pear.php.net/
    
2)  About shibboleth

    Shibboleth is standards-based, open source middleware software which provides Web Single SignOn (SSO) across or within organizational boundaries. It allows sites to make informed authorization decisions for individual access of protected online resources in a privacy-preserving manner.
    
    To learn more about shibboleth please visit the following link:
    
    http://shibboleth.internet2.edu/
    
    For a shibboleth Service Provider deployment guide we recommend the following site:
    
    http://www.switch.ch/aai/tech/
    
    
3)  Creating a database

    You need to create an empty database (eg "glossary") in your database system along with a special user (eg "glossaryuser") 
    that has access to that database (and that database only). You could use the "root" user for a test server, 
    but this is not recommended for a production system: if hackers manage to discover the password then your whole database system
    would be at risk, rather than just one database. 
 
    If you are using a webhost, they will probably have a control panel web interface for you to create your database. 
    
    The Cpanel system is one of the most popular of these. To create a database in Cpanel:
    
    	1. Click on the "MySQL Databases" icon. 
    	2. Type "glossary" in the database field and click "Add Database". 
    	3. Type a username and password (not one you use elsewhere) in the respective fields and click "Add User". 
    	4. Now use the "Add User to Database" button to give this new user account "ALL" rights to the new database. 
    	5. Note that the username and database names may be prefixed by your Cpanel account name. When entering this information into 
           the GLOSSARY installer - use the full names. 
    
    If you have access to Unix command lines then you can do the same sort of thing by typing commands. 
    
    Here are some example Unix command lines:
    # mysql -u root -p
    > CREATE DATABASE glossary; 
    > GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,INDEX,ALTER ON glossary.* TO glossaryuser@localhost IDENTIFIED BY 'yourpassword'; 
    > quit 
    # mysqladmin -p reload


4)  Download and copy files into place 
    
    GLOSSARY is provided as a compressed package. You can find the package on the download page: http://glossary.sourceforge.net/#Download

    After downloading and unpacking the archive you will find a directory called "glossary", containing a number of files and folders.

    You can either place the whole folder in your web server documents directory, in which case the site will be located at
    http://yourwebserver.com/glossary, or you can copy all the contents straight into the main web server documents directory, in which case the site will be simply http://yourwebserver.com. 

    If you are downloading GLOSSARY to your local computer and then uploading it to your web site, it is usually better to upload the whole 
    archive as one file, and then do the unpacking on the server. Even web hosting interfaces like Cpanel allow you to uncompress archives in the "File Manager".


5)  Site structure 
    
    You can safely skip this section, but here is a quick summary of the contents of 
    the glossary folder, to help get you oriented:
    
    config/ 	- contains the configuration file
    core/ 	- contains the php scripts of the application
    export/	- contains the procedures for the export
    images/ 	- contains the images used in the site
    lib/ 	- contains the library that manage errors, communication  with the database and management of uploaded files
    setup/	- contains installer files
    shibboleth/	- contains the page used in shibboleth mode for local registration and the htaccess file that enable shibboleth authentication
    uploads/ 	- default upload directory
    views/	- contains one html file (a template) for each page of the application
    index.php	- first page
    setup.php	- used to load libraries
    readme.txt	- this file    

6)  Create an empty directory somewhere in the web server to store uploaded files (or use the default one) and make it writeable by the web server process.
    

7)  The config/ directory and its content must also be writeable by the web server process.
    

8)  Last step
    
    To end the installation use the WEB INSTALLER, to do that just access the main glossary url (http://yourwebserver.com/glossary or whatever)
        

9)  Known bugs
    
    - No one at the moment
    

10) Next features
    
    - No one at the moment
    

The eLab Team

========================================================================================================================