Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 2.66 KB

README.md

File metadata and controls

83 lines (59 loc) · 2.66 KB

Open OnDemand Dashboard

This app is a Rails app for Open OnDemand that serves as a gateway to launching other Open OnDemand apps. Like all Open OnDemand apps, it's meant to runs as a non-root user.

This is a guide to developing the dashboard.

This documentation assumes you have development enabled for yourself. Containers built in the development documentation have development enabled automatically.

Getting started

First, you'll need to clone this repo and make a symlink.

mkdir -p ~/ondemand/dev
git clone https://github.com/OSC/ondemand.git ~/ondemand/src
cd ~/ondemand/dev
ln -s ../src/apps/dashboard

Open OnDemand sees all of the apps in ~/ondemand/dev and the dashboard is just like any other!

Building

Prerequisites to building are ruby 2.5 and nodejs 12. You'll also need gcc and g++ to build gems and node packages. Getting these available on your systems is left to the reader.

They are available on the webnode based off of RPM/deb package dependencies. However, you may choose to have a different development runtime, and that's fine. OSC maintainers use modules on compute nodes instead of developing on the webnodes themselves.

It should be noted here that any Ruby module installation needs configured with --enable-shared flag to be compatible with the Ruby running on the webnode.

To build run bin/setup from within this directory.

# advanced users may not need to configure bundle. Container users must do this.
bin/bundle config path --local vendor/bundle

bin/setup

Now you should be able to navigate to /pun/dev/dashboard and see the app in the developer views.

Customizing

Now you can refer to the documentation on customizing and make those changes to a .env.local file in the same directory as this README.md.

Refer to the configuration class to see every option available.

Here's the user Annie Oakley's .env.local file to get you started.

# ~/ondemand/dev/dashboard/.env.local

OOD_BRAND_BG_COLOR="#c1a226" #gold
#OOD_LOAD_EXTERNAL_CONFIG=1
#OOD_LOAD_EXTERNAL_BC_CONFIG=1
OOD_APP_SHARING=true

MOTD_PATH="/etc/motd"
MOTD_FORMAT="osc"
SHOW_ALL_APPS_LINK=1

OOD_CLUSTERS="/home/annie.oakley/ondemand/misc/clusters.d"
OOD_CONFIG_D_DIRECTORY="/home/annie.oakley/ondemand/misc/config/ondemand.d"

OOD_BALANCE_PATH="/home/annie.oakley/ondemand/misc/config/balances.json"
OOD_BALANCE_THRESHOLD=50
OOD_QUOTA_PATH="/home/annie.oakley/ondemand/misc/config/quotas/my_quota.json"
OOD_QUOTA_THRESHOLD=0.1