Linker/Build Configuration

From BioAssist
Jump to: navigation, search

Configuration

The configuration has been subdivided as mandatory and optional. Mandatory configuration Parameters must be changed for building / installing the Popup. The optional parameters are as the name suggests 'optional'.

PHP configuration

Mandatory

Rename the <base_folder>/etc/settings_skeleton.php file to settings.php.

  1. $lintPath = the absolute path of the lint. <base_folder>/JSLint_source/Linux_All_DBG.OBJ/jsl.
  2. $srcPath = the absolute path of the “src” folder. "<base_folder>/src".
  3. $buildPath = The folder path from which apache web server will serve the files. "/var/www/linker".
  4. $inputFileSet2 = The set of js files that will be copied to the apache directory (if a new js file is added the same needs to be added here as well).

Optional

JavaScript Configuration

Mandatory

Rename the <base_folder>/src/etc/settings_skeleton.js rename to settings.js

  1. var DEBUG = Toggles the javascript debug panel
  2. var LANDINGPAGE = The index page that will be shown when the application is invoked
  3. var HOST = Used to create relative URL's to the python scripts etc.
  4. var SHOW_xxx = Used to show hedaders in the popup. Possible values are true / false / satellite (additional popup).
  5. var TITLE_xxx = The title for the headers in the popup. Only in english
  6. var EMPTY_xxx = Error messages when data for the heaer in the popup is not found. Only in English
  7. var REQUEST_xxx = AJAX call timeouts and retries. Adjust for development machine

Optional

  1. var SOURCEHOST = unused
  2. var CONCEPTWEBHOST = URL used to register to the concept web in the popup (currently disabled)
  3. var PORTAL = used by sources.js
  4. var ANNOTATION_WIKI = used to go to wiki page (currently disabled)
  5. var SEARCH_ENGINES = Supported search engines.

Python Configuration

Mandatory

rename <base_folder>/src/etc/settings_skeleton.ini to settings.ini

  1. [CrossDomain] = Used by getDefinitions.py.
  2. [API] = Knewco API's used for indexing etc.
  3. [LandingPage] = The default page opened on application invocation.
  4. [Log] = default logging parameters for python. The path defined in “file” must be available and have write permissions or the python script will throw an error.

Optional

  1. [Peregrine] = Unused
  2. [Amazon] The Amazon API settings including the application key

Apache Configuration

Mandatory

Assuming your build directory is /var/www/linker

 <Directory "/var/www/linker">
       Options ExecCGI -MultiViews FollowSymLinks
       AllowOverride All
       Order allow,deny
       Allow from all
       AddHandler mod_python .py
       PythonHandler launch
       PythonDebug On
 </Directory>

Build and Install

Prerequisites

  • PHP version 5 and above.
 PHP 5.2.6-3ubuntu4.2 with Suhosin-Patch 0.9.6.2 (cli) (built: Aug 21 2009 21:43:13) Copyright (c) 1997-2008 The PHP Group. 
 Zend Engine v2.2.0, Copyright (c) 1998-2008 Zend Technologies
  • Apache 2 and above with the following extensions:
  1. mod_php
  2. mod_python 3.3.1 and above. Anything below mod_python 3.3.1 will cause an error in the python scripts
  3. mod_perl: version 5 and above, required for nph-proxy.cgi
 Apache/2.2.11 (Ubuntu) PHP/5.2.6-3ubuntu4.2 with Suhosin-Patch mod_python/3.3.1 Python/2.6.2 mod_perl/2.0.4 Perl/v5.10.0

Build

  • Rename the configuration files
  • Change the mandatory configuration
  • Run the linkerBuild.php: php linkerBuild.php. Switches available for linkerBuild.php
  1. -nominify: does not minify the javascript files
  2. -lint: uses js lint to verify the javascript files
  3. -usepacker: packs the javascript files to a single file
  • run apache webserver
  • Point the browser to the URL defined in the HOST configuration parameter.