Quickstart

Get started with Orphelix in under 5 minutes

Prerequisites

Before you begin, make sure you have:

Node.js 24 or higher

Download from nodejs.org

kubectl (optional)

Only needed for connecting to real clusters. Install from kubernetes.io

Installation

CLI (Recommended)

Easiest way to run Orphelix - one command setup!

1. Clone the repository

   git clone https://github.com/corapoid/orphelix.git
   cd orphelix/app
   
2. Start Orphelix

   npm run orphelix start
   

   First run automatically:

   • Installs dependencies
   • Builds application
   • Configures custom hostname
   • Initializes database
   • Starts in background
3. Open in browser

   npm run orphelix open
   

   Or visit: http://orphelix.local:3000

Orphelix runs as a background service using PM2. No need to keep terminal open!

See CLI Guide for all commands.

Development Mode

For development and testing:

1. Clone the repository

   git clone https://github.com/corapoid/orphelix.git
   cd orphelix/app
   
2. Install dependencies

   npm install
   
3. Start the development server

   npm run dev
   
4. Open in browser

   Navigate to http://localhost:3000

   The application starts in Demo Mode with realistic test data.

Exploring Demo Mode

Demo Mode lets you explore all features without connecting to a real cluster:

Dashboard

View summary cards showing resource counts (Deployments, Pods, Nodes, etc.)

Deployments

Browse deployment lists, view details, and see associated pods

Pods

Inspect pod details, view container logs, and check events

Topology

Visualize resource relationships in an interactive graph

Demo Mode uses realistic mock data that simulates a production environment. Perfect for testing, presentations, or learning Kubernetes concepts.

Connecting to a Real Cluster

1. Click the 'DEMO MODE' badge

   Located in the top-right corner of the header

2. Select 'Real Cluster'

   Choose your kubectl context from the dropdown

3. Select namespace

   Pick the namespace you want to monitor (default: ‘default’)

4. Test connection

   Click ‘Test Connection’ to verify cluster access

5. Switch mode

   Click ‘Switch to Real Cluster’ to start monitoring live resources

Make sure your ~/.kube/config file is properly configured and you have appropriate permissions to access the cluster.

Next Steps

CLI Guide

Learn all CLI commands and features

User Guide

Learn how to use all features in detail

GitHub Integration

Set up GitOps workflow with YAML editor and PR creation

Configuration

Configure cluster connections, namespaces, and settings

CLI Management

Orphelix CLI provides powerful commands for managing your dashboard:

# View status
npm run orphelix status

# View logs
npm run orphelix logs

# Restart application
npm run orphelix restart

# Create backup
npm run orphelix backup

# Enable auto-startup on boot
npm run orphelix startup

# Run health checks
npm run orphelix doctor

See CLI Commands for complete reference.