9 - Installing LexEVS 6.x CTS2 Documentation API Service

Instructions for installing LexEVS 6.x CTS2 Documentation API Service.

• The installation directory can be anywhere.
• The name of the install directory will be "cts2Docs".
• The path to the install directory will be referred to as "<path to install dir>"

Access to other Systems

• This server needs to be able to access the CTS2 service located here: http://lexevs62cts2.nci.nih.gov/lexevscts2 

Step-by-step installation guide

Create an install directory called <path to install dir>/cts2Docs
Go into the install directory

• cd <path to install dir>/cts2Docs

Install CTS2 API Documentation project

1. Clone git repository

   1. git clone https://github.com/cts2/lexevs-service-rest-docs.git
   2. This will create a project under <path to install dir>/cts2Docs/lexevs-service-rest-docs
      
    

Install Node.js

1. Download Node.js (linux 64 bit) (v0.10.35) to <path to install dir>/cts2Docs
   
   1. File download location: nodejs.org/dist/v0.10.35/node-v0.10.35-linux-x64.tar.gz
2. Unzip the file node-v0.10.35-linux-x64.tar.gz in <path to install dir>/cts2Docs
   
   1. tar -vxzf node-v0.10.35-linux-x64.tar.gz
3. Add an environment variable for NPM

   1. export NPM_HOME=<path to install dir>/cts2Docs/node-v0.10.35-linux-x64

   2. export PATH=${PATH}:$NPM_HOME/bin

4. Update the port that node.js runs on (OPTIONAL step)
   1. Edit this file: <path to install dir>/cts2Docs/lexevs-service-rest-docs/config.json
   2. The "port" parameter is set to 3000 by default.  It can be changed as needed.  This port used by the end URL to get to the CTS2 API Documentation: (http://<server_name>:port)
      

Install Redis

1. Download Redis version 2.8.19 to <path to install dir>/cts2Docs
   
   1. File download location: https://github.com/antirez/redis/archive/2.8.19.tar.gz
2. Unzip the file redis-2.8.19.tar.gz in <path to install dir>/cts2Docs
   
   1. tar -vxzf redis-2.8.19.tar.gz
3. Build redis
   1. cd <path to install dir>/cts2Docs/redis-2.8.19
   2. make

Install Directory File Structure

At this point the install directory should have the following structure:

•  cts2Docs
  • lexevs-service-rest-docs
  • node-v0.10.35-linux-x64
  • redis-2.8.19

Change Directory permissions

For security purposes, restrict access to the following directories/files:

• chmod 700 <path to install dir>/cts2Docs/lexevs-service-rest-docs
• chmod 700 <path to install dir>/cts2Docs/lexevs-service-rest-docs/app.js
• chmod 700 <path to install dir>/cts2Docs/lexevs-service-rest-docs/views
• chmod 700 <path to install dir>/cts2Docs/lexevs-service-rest-docs/node_modules
  
• chmod 700 <path to install dir>/cts2Docs/lexevs-service-rest-docs/public
• chmod 700 <path to install dir>/cts2Docs/lexevs-service-rest-docs/public/*
• chmod 600 <path to install dir>/cts2Docs/lexevs-service-rest-docs/public/javascrips/*.js
  
• chmod 754 <path to install dir>/cts2Docs/redis-2.8.19

Start the Services

1. Start the redis server
   
   1. nohup <path to install dir>/cts2Docs/redis-2.8.19/src/redis-server &
   2. By default, redis is running on port 6379
2. Start the Node.js server
   1. cd <path to install dir>/cts2Docs/lexevs-service-rest-docs
   2. nohup npm start &
   3. node.js is set to run on port 3000 by default.
      

Accessing the CTS2 Documentation API Service

Once redis and node.js have been successfully started, the CTS2 Documentation API service can be reached at the following URL:

http://<server_name>:port

 

Related articles