Home

nself Admin Documentation

Version 0.0.8 · MIT License · Docker-ready

The web UI for the nself CLI. Manage your self-hosted backend stack from a browser.

---

Welcome to nself Admin

nself Admin (nAdmin) is a web-based UI wrapper for the nself CLI that makes setting up and managing modern development stacks effortless. With an intuitive wizard interface, real-time monitoring, and full service management, nAdmin transforms complex Docker orchestration into a simple point-and-click workflow.

Why nself Admin?

Feature	Description
Zero-Config Start	Launch a complete development stack in under 5 minutes
Intelligent Wizard	6-step configuration with smart defaults and validation
Real-Time Monitoring	Live metrics, logs, and health checks for all services
Docker-First Design	Runs in a container with zero footprint on your host
Plugin System	Extend with Stripe, GitHub, Shopify integrations
40+ Templates	Pre-configured for Node.js, Python, Go, Rust, and more
Multi-Environment	Manage dev, staging, and production configs

---

Quick Navigation

Getting Started

• Quick Start - Get running in 5 minutes
• Init Wizard Guide - Complete wizard walkthrough
• Dashboard Overview - Master the dashboard

Core Documentation

• Architecture - System design and components
• Service Configuration - Configure all services
• Database Management - PostgreSQL operations
• Monitoring - Metrics and alerting

Plugin System (NEW in v0.0.8)

• Plugins Overview - Complete plugin documentation
• Stripe Plugin - Payment processing integration
• GitHub Plugin - Repository and DevOps data
• Shopify Plugin - E-commerce integration
• Webhook Integration - Real-time event handling

Reference

• API Reference - Complete REST API documentation
• Environment Variables - All configuration options
• CLI Integration - Working with nself CLI

Deployment

• Production Deployment - Deploy to production
• Updates - Keeping nAdmin up to date
• CI Setup - Continuous integration configuration

Help

• FAQ - Frequently asked questions
• Troubleshooting - Common issues and solutions
• Security - Security best practices
• Security Audit - Full security audit report

---

Technology Stack

Layer	Technology
Frontend	Next.js 16, React 19, TypeScript
Styling	Tailwind CSS v4
State	Zustand
Database	LokiJS (embedded)
Container	Docker API via Dockerode
Real-time	WebSockets, Server-Sent Events

---

Project Links

• GitHub: nself-org/admin
• Docker Hub: nself/nself-admin
• Issues: Report bugs or request features
• Discussions: Join the community

---

Current Version

v0.0.8 - See CHANGELOG for details.

License

MIT License - See LICENSE for details.