Installing TSE

Home | Requirements | Install 

Overview

To install TSE you need to:

1. Download and unpack the TSE distribution into a folder in your web site
2. Configure: Edit configure.inc.php
   • specify whether you are using the XSLT extension
   • specify a web proxy (if any)
   • enter Google API key
   • enter uBio key
   • set the cache directory
3. Create cache directory

1. Getting started

Download and unpack the TSE distribution. Put the folder into a folder visible over the web. On a Linux box this might be /var/www/htdocs if it is going on the root of the site, or in your public_html folder if you are serving files from your home folder. On a Mac OS X machine, put it in your Sites folder.

3. Editing the configuration files

Open the file config.php.inc and edit the settings.

Sablotron

If your copy of PHP has the XSLT extension installed then you can leave the sabcmd setting blank. However, if you don't have the XSLT extension (for instance, the PHP that comes with Red Hat 8 doesn't) then you need to have access to Sablotron.

$config['sabcmd']       = '/usr/local/bin/sabcmd';

Web proxy

If you access the web through a proxy server, then set the details of the server here to ensure that the code that talks to PubMed functions correctly. Otherwise leave these settings as they are. For example, at Glasgow University the proxy_name would be http://wwwcache.gla.ac.uk and the proxy_port would be 8080.

$config['proxy_name']   = '';
$config['proxy_port']   = '';

Goggle key

The Google spelling service requires a Google API key, available from Google.

$config['Google_key'] 		='XP....y'; 

uBio key

uBio's web service a key, available from uBio.

$config['uBio_key'] 		='b7...c'; 

Cache folder

To improve performance TSE can use a cache. You need to specify this directory (using the absolute file path), and how long a record should stay cached (in seconds).

// 0 means the cache isn't being used.
// 86400 seconds = 24 hours
$config['cache_dir'] 			= '/home/rpage/public_html/portal/cache'; 
$config['cache_time'] 			= 86400; 

Cache folder

If you are going to use the cache, you need to have a directory that is writeable by the web server. For example, you can create a folder called cache in the root of the TSE folder. You need set the permissions of this folder so that the web server can write to it (on a Mac the web server runs as user www):

	mkdir cache
	chown www cache

You're done!