Niksphere Documentation

Welcome to the official documentation for the Niksphere Enterprise Application Platform (EAP).

Quickstart

Practical hands-on entry points for developers, system administrators, and key users.

Quickstart Hub — Overview of roles and setup paths.
CLI Installation & Setup — Install nik, authenticate with Cloud, and connect to engines.
Engine Installation & Setup — Run the engine locally with SQLite or PostgreSQL.

Task-oriented guides to build, customize, deploy, and automate Niksphere applications.

Guides Overview — Index of available guides.
Developing & Publishing in VS Code — Manifest creation, Pascal LSP, Ctrl+Shift+B compile, and Ctrl+F5 publish.
Managing Environments & Apps in VS Code — Manage environments, log streaming, and app lifecycles in the VS Code sidebar.
Engine Service Management — Run the Engine as a Windows Service or Linux systemd service.

High-level design principles, layer concepts, and platform architecture.

Architecture Overview — Architecture index and technical specifications.
Product Overview & Vision — High-level architecture and platform philosophy.
Layer System ("Everything is an App") — The 4-layer customization model.
Engine Deployment Architecture — Niksphere Cloud (Fully Managed) vs. Self-Hosted (Docker / Standalone Binary).
Engine Database Architecture — Multi-database schema isolation and dual-driver storage.
Authentication & IDP Broker — Built-in identity provider and external SSO.
Glossary & Terminology — Key terms and architectural concepts.

Exhaustive specifications, schemas, and CLI commands.

Reference Overview — Technical reference index.
CLI Reference (nik) — Complete documentation of all nik dev, nik env, and nik cloud commands.
VS Code Extension Settings & Tasks — Commands, settings, shortcuts, and task configurations.
Engine Configuration — Environment variables (NIKSPHERE_ENGINE_*) and config.yaml schema.
Engine API Reference — Complete REST, WebSocket, OIDC Authentication, and App Runtime API documentation.
Cloud API Reference — Complete Niksphere Cloud REST API and platform management endpoints.