Basic Setup

Setting up the HPC Dashboard requires Node.js and access to a SLURM cluster with API capabilities. Follow these steps to get your dashboard up and running quickly.

Prerequisites

Before installation, ensure you have:

• Node.js (v18 or later)
• npm or Yarn
• PM2 (for production deployment)
• SLURM cluster with REST API enabled
• SLURM API user credentials
• SLURM API token
• Root permissions on the installation system

Quick Installation

Step 1: Clone the Repository

Begin by installing the dashboard. You will be required to select a branch. Normally the main branch is recommended.

npx create-slurm-dashboard slurm-node-dashboard

Once complete, change in to the directory.

cd slurm-node-dashboard

Step 2: Install Dependencies

Install all required dependencies:

npm install

Step 3: Configure Environment

setup your production environment by moving the .env.production to .env

mv .env.production .env

update the file for your environment

# BASE
COMPANY_NAME="Acme Corp"
NEXT_PUBLIC_BASE_URL="http://localhost:3000"
VERSION=1.1.2
CLUSTER_NAME="Cluster"
CLUSTER_LOGO="/cluster.png"

# DEV
NODE_ENV="dev"
REACT_EDITOR="code"

# SLURM
SLURM_API_VERSION="v0.0.40"
SLURM_SERVER="192.168.1.5"
SLURM_API_TOKEN=""
SLURM_API_ACCOUNT=""

# PLUGINS
NEXT_PUBLIC_ENABLE_OPENAI_PLUGIN=false
NEXT_PUBLIC_ENABLE_PROMETHEUS_PLUGIN=false

Step 4: Start Development Server

Launch the development server to test your installation:

npm run dev

Visit http://localhost:3000 in your browser to view the dashboard.

What's Next?

After installation, you can:

• Configure advanced features like OpenAI integration or Prometheus metrics
• Set up data collection scripts for historical data
• Integrate with Open OnDemand