diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..8cd78e3 --- /dev/null +++ b/.env.example @@ -0,0 +1,20 @@ +# NemoClaw Dashboard Configuration +# Copy this file to .env.local and customize + +# OpenShell/Kubernetes namespace to monitor +NEXT_PUBLIC_KUBERNETES_NAMESPACE=agent-sandbox-system + +# Docker container name running OpenShell +OPEN_SHELL_CONTAINER=openshell-cluster-openshell + +# Dashboard port +NEXT_PUBLIC_DASHBOARD_PORT=3000 + +# API endpoints +NEXT_PUBLIC_API_BASE=/api + +# Enable Create/Destroy operations +NEXT_PUBLIC_ENABLE_SANDBOX_OPERATIONS=true + +# Optional: Override default namespace if using different one +# KUBERNETES_NAMESPACE=your-custom-namespace diff --git a/README.md b/README.md index f182ddc..f02a8ad 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,23 @@ A web-based control plane dashboard for managing OpenShell and NemoClaw instance ## Installation +### Quick Install (Recommended) + +Run the installer script which checks prerequisites and sets up everything: + +```bash +./install.sh +``` + +The installer will: +- ✅ Verify Node.js, npm, and Docker are installed +- ✅ Check that your OpenShell-Mark container is running +- ✅ Install npm dependencies +- ✅ Build the dashboard +- ✅ Create `.env.local` configuration file + +### Manual Install + 1. Navigate to the project directory: ```bash cd nemo-shell-dashboard @@ -22,8 +39,17 @@ cd nemo-shell-dashboard npm install ``` +## Prerequisites + +- **Node.js** 18+ +- **npm** 9+ +- **Docker** (Docker Desktop on Mac, or native Docker on Linux) +- **OpenShell-Mark fork running**: `ghcr.io/nvidia/openshell/cluster:dev` + ## Running the Dashboard +After running `./install.sh`: + 1. Start the development server: ```bash npm run dev @@ -34,6 +60,26 @@ npm run dev http://localhost:3000 ``` +> **Important**: Make sure your OpenShell-Mark container is running before starting the dashboard! + +### On Mac +```bash +# Start OpenShell first +/Applications/Docker.app/Contents/Resources/bin/docker run -d --name openshell-cluster -p 8080:30051 ghcr.io/nvidia/openshell/cluster:dev + +# Then start the dashboard +npm run dev +``` + +### On Linux +```bash +# Start OpenShell first +docker run -d --name openshell-cluster -p 8080:30051 ghcr.io/nvidia/openshell/cluster:dev + +# Then start the dashboard +npm run dev +``` + ## Configuration The dashboard will attempt to connect to: