Moved to https://github.com/OSC/ondemand/tree/master/apps/shell

OOD Shell

This app is a Node.js app for Open OnDemand providing a web based terminal using Chrome OS's hterm. It is meant to be run as the user (and on behalf of the user) using the app. Thus, at an HPC center if I log into OnDemand using the ood account, this app should run as ood.

New Install

Start in the build directory for all sys apps, clone and check out the latest version of the shell app (make sure the app directory's name is shell):
```
scl enable rh-git29 -- git clone https://github.com/OSC/ood-shell.git shell
cd shell
scl enable rh-git29 -- git checkout tags/v1.4.2
```

Install the app:

scl enable rh-git29 rh-ruby24 rh-nodejs6 -- bin/setup

Copy the built app directory to the deployment directory, and start the server. i.e.:
```
sudo mkdir -p /var/www/ood/apps/sys
sudo cp -r . /var/www/ood/apps/sys/shell
```

Updating to a New Stable Version

Navigate to the app's build directory and check out the latest version:

cd shell # cd to build directory
scl enable rh-git29 -- git fetch
scl enable rh-git29 -- git checkout tags/v1.4.2

Update the app:

scl enable rh-git29 rh-ruby24 rh-nodejs6 -- bin/setup

Copy the built app directory to the deployment directory:

sudo rsync -rlptv --delete . /var/www/ood/apps/sys/shell

Configuration

The app can be configured by editing the global environment file:

/etc/ood/config/apps/shell/env

An example environment file is:

# /etc/ood/config/apps/shell/env

# The default ssh host the user is logged into if the user doesn't specify a
# host in the url
DEFAULT_SSHHOST="localhost"

Usage

Open a terminal to the default SSH host:

http://localhost:3000/

To specify the host:

http://localhost:3000/ssh/<host>

To specify a directory on the default host:

http://localhost:3000/ssh/default/<dir>

To specify a host and directory:

http://localhost:3000/ssh/<host>/<dir>

Development

For development purposes the environment variables must be specified in the local environment file:

.env.local

underneath the root directory of this app in your sandbox.

To mimic the production environment you may have to copy the production environment variables down or set up a symbolic link:

# Copy production env vars
cp /etc/ood/config/apps/shell/env .env.local

# or setup a symlink
ln -s /etc/ood/config/apps/shell/env .env.local

Any changes made to the environment files require an app restart in order for the changes to take effect:

$ touch tmp/restart.txt

Updating `hterm`

Clone Google's repository that includes some other things in addition to hterm:

$ git clone https://chromium.googlesource.com/apps/libapps

Run the build script. It requires Python, specifically Python 3 for hterm 1.81 and newer. Here, it is run from the root directory of this new local repository (libapps):

$ scl enable rh-python35 -- hterm/bin/mkdist.sh

There will be a file created in hterm/dist/js called hterm_all.js. Copy and rename this file to public/javascripts/hterm_all_x.xx.js in the Shell App repository, where x.xx represents the version number hterm (for cache busting), and change the reference in views/index.hbs to point to this new file.

Hacking `hterm`

So you've updated hterm and now something is broken. Maybe only on one platform (cough firefox). Here's a list of hacks/changes we've made to these files so when you're updating from one version to another you may have to add these changes. If you're lucky you may be able to cherry pick them, if not, hopefully we've made an issue where you can reference and you can at least see the commit.

0cbc84e3d53386064e278a0495c940a217f4f18b - that fixed issue 64

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/OSC/ood-shell.

License

The gem is available as open source under the terms of the MIT License.

jasonbuechler/ood-shell