Skip to content
momipsl edited this page Oct 8, 2014 · 28 revisions

Introduction

The esdoc-shell is the command line interface between a system admin / developer / user and the ES-DOC software stack. The shell consists of a primary script file: exec.sh and uses 2 config files which are installed along with the stack.

Installing

Step 1: Download source code from GitHub

cd YOUR_WORKING_DIRECTORY
git clone https://github.com/ES-DOC/esdoc-shell.git esdoc

Step 2: Run bootstrapper

cd YOUR_WORKING_DIRECTORY
./esdoc/exec.sh stack-bootstrap

This will create the following config files in ./esdoc/ops/config:

  1. esdoc.json
  2. esdoc.sh
    If you plan to run server side processes then you will need to edit these file to reflect the setup of your environment.

Step 3: Run installer

cd YOUR_WORKING_DIRECTORY
./esdoc/exec.sh stack-install

This creates a local python executable plus the associated virtual environments required to run various aspects of the full stack.

Step 4: Create aliases To setup ES-DOC command line aliases add the following line to your bash profile file ($HOME/.bash_profile):

test -f YOUR_WORKING_DIRECTORY/esdoc/exec.aliases && source YOUR_WORKING_DIRECTORY/esdoc/exec.aliases

Updating

cd YOUR_WORKING_DIRECTORY
./esdoc/exec.sh stack-update

Please update whenever you receive notification of an ES-DOC release.

Uninstalling

cd YOUR_WORKING_DIRECTORY
./esdoc/exec.sh stack-uninstall

Clone this wiki locally