Getting Started

Nebula can be run locally for evaluation or deployed to production for full network monitoring. The steps below get you up and running.

Prerequisites

• Node.js 18+ and npm
• Git for fetching the source
• Optional: Go toolchain for building custom collectors

Installation

1. Clone the repository: git clone https://github.com/NebulaRMM/nebula
2. Enter the website directory and install dependencies with npm install
3. Start the development server using npm run dev
4. Open http://localhost:3000 to view the dashboard

Using Core Features

Add your network ranges in the settings panel to begin discovery. The collector agent can be deployed on Windows, Linux or macOS to gather metrics. Use the dashboard to view maps, create alerts and browse historical data.

When you're ready for production, run npm run build to create an optimized build. See the repository documentation for deploying the API and collectors.

Full documentation, architecture notes and design documents live in the NebulaRMM/nebula repository.