Quick Start Guide

Get your Slurm HPC Dashboard up and running in minutes

Follow these simple instructions to set up the HPC Dashboard quickly and start monitoring your SLURM cluster right away:

Basic Setup

  1. Clone and Install

    • Clone the repository and install dependencies:

      git clone https://github.com/thediymaker/slurm-node-dashboard.git
cd slurm-node-dashboard
npm install

  2. Configure Environment

    • Create a .env file in the project root with your cluster information:

      # BASE

COMPANY_NAME="Acme Corp"
VERSION=1.1.2
CLUSTER_NAME="Cluster"
CLUSTER_LOGO="/cluster.png"

NODE_ENV="dev"
REACT_EDITOR="code"

# SLURM

SLURM_API_VERSION="v0.0.40"
SLURM_SERVER="192.168.1.5"
SLURM_API_TOKEN="1234"
SLURM_API_ACCOUNT="slurm"

  3. Launch the Dashboard

    • Start the development server:

      npm run dev

    • Access your dashboard at http://localhost:3000

Tip: For a quick SLURM token, run scontrol token username=slurm lifespan=31536000 on your cluster.

Warning:

Creating a slurm key with a long lifespan can be a security concern. Shorter life keys and rotating them can help prevent unauthorized access to slurm.

Next Steps

After the basic setup, you can:

  • Configure OpenAI integration for the AI assistant
  • Set up Prometheus for additional metrics
  • Deploy the dashboard to production using PM2
  • Integrate with Open OnDemand

Refer to the Installation Guide for detailed setup instructions