OOR SandBox Customization

This page describes installation and customization details to the NCBO Virtual Appliance to create an OOR instance.

Download
Download the OVF image for the NCBO Virtual Appliance. The URL is not public.

The current version (used in examples below) is ncbo-appliance-0.3.ova.

VM Conversion
The OVF image needs to be converted for the desired VM environment.

VMware
The image requires a 64-bit host with enabled support for Intel Virtualization Technology (VT).

To convert the OVF image for execution under VMware:


 * 1) Download VMware OVF Tool from http://www.vmware.com/support/developer/ovf/.
 * 2) Run  ovftool ncbo-appliance-0.3.ova.
 * 3) Execute the resulting  ncbo-appliance-0.3/ncbo-appliance-0.3.vmx  file under VMware, by double-clicking the file icon or opening it within VMware.
 * 4) Click through the initial Linux text screen setup questions.

Xen

 * at CIM3 we use para-virtualized guests (and therefore, would prefer vm images for that over fully-virtualized guests.) --ShinyaYamada/2011.10.31

To convert the OVF image for execution under Xen:


 * 1) Download XenConvert from http://www.citrix.com/english/ss/downloads/details.asp?downloadId=2306318.
 * 2) Run XenConvert under Windows.  This requires access to a running XenServer.

This hasn't yet been successfully accomplished.

KVM
... (coming!)

Banner, Logo, etc.

 * 1) Login to the running image.
 * 2) Edit  /var/rails/ BioPortal /current/config/bioportal_config.rb, changing at least
 * ORG (e.g. to SOCoP)
 * SITE (e.g. to OOR)
 * ORG_URL (e.g. to http://socop.org).
 * 1) Replace the BioPortal logo with the OOR logo.
 * public/maintenance/nav_logo.jpg            (126x43)  Medium logo using the color gradient
 * public/maintenance/logo_background.jpg     (1x43)    The color gradient
 * public/images/ncbo_logo_portal.gif          (463x157) Large logo
 * public/images/logo.png                     (463x157) Large logo copy
 * public/images/layout/logo_mini.png         (85x20)   Small logo using the color gradient
 * public/images/layout/nav_logo.png          (126x43)  Medium logo copy
 * 1) Replace the BioPortal IPR policy with the OOR or instance policy.
 * The IPR license is at license.txt
 * 1) "Send Feedback" form should be mailed to 
 * which currently gets forwarded to: TejasParikh, KenBaclawski, MikeDean, PeterYim and  (i.e. the [oor-dev] mailing list) --PeterYim/2011.10.14
 * admin contact is now routed to  --tejas/2011.12.11
 * 1) Run  ncborestart.

Enable Google Analytics

 * Enter the appropriate ID below as $ANALYTICS_ID  in  bioportal_config.rb
 * OOR-instance / Web Property ID
 * sandbox.oor.net / UA-7295028-10
 * dev.oor.net / UA-7295028-11
 * socop.oor.net / UA-7295028-12

Ontology Categories

 * 1) Add OOR categories below per the instructions at http://www.bioontology.org/wiki/index.php/Virtual_Appliance_FAQ#How_do_I_add_or_change_categories.3F.
 * 2) You may need to download the MySQL JDBC driver and copy it to the Protege directory as  driver.jar  per http://protegewiki.stanford.edu/wiki/Working_with_the_Database_Backend_in_OWL#Before_you_start
 * 3) Use  jdbc:mysql://localhost/bioportal_protege  and run, e.g.,  ssh oor-03.cim3.net -L 3306:localhost:3306
 * 4) Run  ncborestart.
 * 5) Verify the updated categories by opening the Browse panel and clicking the Filter by Category menu


 * Category list (based on MikeDean's original list): (updated 2011.08.05)
 * 1) Upper Ontologies
 * 2) Standards (for example, W3C, ISO, OMG, Measurement)
 * 3) Science (for example, Biomedical)
 * 4) Financial
 * 5) Government
 * 6) Cultural
 * 7) Social Networking (for example, People, Organizations)
 * 8) Geospatial
 * 9) Commercial
 * 10) Literature
 * 11) Technology
 * 12) Provenance
 * 13) Defense
 * 14) Metadata (for example, OMV, Dublin Core)
 * 15) Process (for example, PSL)
 * 16) Other

Support / Syndication / Social Network

 * The twitter and facebook buttons can easily be removed by commenting out the div element with id "social_networking" in .../ BioPortal /current/app/views/home/index.rhtml  (on lines 154 to 157). If you want to enable them, then you must define home.facebook_button and home.twitter_button.
 * As mentioned in above: feedback and support goes to 
 * The RSS feed citation can be removed from .../ BioPortal /current/config/locales/en.rb

Home Page Statistics

 * 1) Edit  /srv/ncbo/rails/ BioPortal /current/config/locales/en.rb  to set  :stats => ''.
 * 2) Manually edit  :most_viewed  in the same file, if desired for Most Viewed Ontologies.

reCaptcha

 * This is important for preventing wikispam.
 * If you do not have a google account then signup for one.
 * Go to http://www.google.com/recaptcha.
 * Click on "My Account" and then "Add a new site".
 * Enter the domain or IP address of the server (e.g., oor-03.cim3.net ).
 * Note that you need a different pair of keys for each domain.
 * Copy the public and private keys to /srv/ncbo/rails/ BioPortal /current/config/bioportal_config.rb  as follows (except for replacing the keys):
 * ENV['USE_RECAPTCHA'] = 'true'
 * ENV['RECAPTCHA_PUBLIC_KEY'] = '6Ld9UM0SAAAAAG9kx-VF6rPb_Be-gHO21DnlH2jN'
 * ENV['RECAPTCHA_PRIVATE_KEY'] = '6Ld9UM0SAAAAADgdc3sw8O_-hEQa-Vab-I9cDov4'
 * Restart the services with "sudo ncborestart".

Other Updates

 * All updates in this section are relative to .../ BioPortal /current
 * app/views/home/all_resources.html.erb Change "Search biomedical resources" to "Search resources"
 * app/views/home/help.html.erb Change "How to Cite < BioPortal " to "How to Cite OOR", and then change the citation just below this.
 * app/views/home/index.rhtml This is the home page, so make changes as needed. One such change is mentioned above.