acamarata/nself-admin repository overview

docker run -d \
  -p 3021:3021 \
  -v /path/to/your/project:/workspace:rw \
  -v nself-admin-data:/app/data \
  --name nself-admin \
  acamarata/nself-admin:latest

Open http://localhost:3021 in your browser.

✨ Key Features

- Zero-footprint deployment - Runs entirely in Docker, no host dependencies
- Project Setup Wizard - 4-step guided configuration for new projects
- Real-time monitoring - Live metrics for all services and containers
- Database management - Built-in PostgreSQL admin tools with query editor
- Service orchestration - Start, stop, and manage all backend services
- Secure authentication - Session-based auth with bcrypt password hashing
- LokiJS embedded database - No external database required
- GraphQL/Hasura integration - Manage your GraphQL APIs
- Auto-discovery - Automatically detects and manages nself services
- Multi-platform support - Works on AMD64 and ARM64 architectures

📋 Requirements

- Docker 20.10 or later
- An nself project directory to manage
- Port 3021 available (configurable)

🔧 Configuration

Volumes

- /workspace - Mount your nself project directory here (read/write)
- /app/data - Persistent storage for admin database and sessions

Environment Variables

- PORT - Server port (default: 3021)
- NODE_ENV - Environment mode (development/production)
- NSELF_PROJECT_PATH - Path to project (default: /workspace)

Ports

- 3021 - Web interface (map to any available port)

🏗️ Architecture

nAdmin follows a Docker-first approach:
- Runs completely isolated in a container
- Never modifies your host system
- Manages your project through volume mounts
- All state stored in embedded LokiJS database
- Optimized image size (421MB) using Next.js standalone build

🔐 Security

- Password protected access with secure setup flow
- Session-based authentication (24-hour TTL)
- CSRF protection on all endpoints
- Audit logging with 30-day retention
- Development vs production security modes
- Non-root container execution

📦 Version Tags

- latest - Latest stable release
- 0.0.3 - Current version with LokiJS integration
- 0.0.2 - Previous stable version (deprecated)

🛠️ Example Deployment

Basic Setup

# Create persistent volume for data
docker volume create nself-admin-data

# Run nAdmin
docker run -d \
  -p 3021:3021 \
  -v $(pwd)/my-project:/workspace:rw \
  -v nself-admin-data:/app/data \
  --name nself-admin \
  acamarata/nself-admin:latest

With Docker Compose

version: '3.8'
services:
  nself-admin:
    image: acamarata/nself-admin:latest
    ports:
      - "3021:3021"
    volumes:
      - ./my-project:/workspace:rw
      - nself-admin-data:/app/data
    restart: unless-stopped

volumes:
  nself-admin-data:

🔄 Upgrade Instructions

From v0.0.2 to v0.0.3:
1. Stop and remove the old container
2. Pull the new image
3. Start with the volume mount for /app/data
4. Set a new admin password on first login

📚 Documentation & Support

- GitHub Repository: https://github.com/acamarata/nself-admin
- Documentation: https://github.com/acamarata/nself-admin/wiki
- Issue Tracker: https://github.com/acamarata/nself-admin/issues
- Telegram Support: @nselforg
- Commercial Licensing: https://nself.org/commercial

📝 License

Dual licensed - Free for personal use, commercial license required for business use.

⚠️ Alpha Release Notice

This is an alpha release (v0.0.x). Breaking changes may occur between versions. While stable for development use, thorough
testing is recommended before production deployment.

🎯 What's New in v0.0.3

- LokiJS Database Integration - Replaced .env files with embedded database
- Project Setup Wizard - Guided 4-step configuration
- Optimized Image Size - Reduced from 3.69GB to 421MB (88% smaller)
- Multi-platform Support - AMD64 and ARM64 architectures
- Improved Authentication - Session-based with CSRF protection
- TypeScript Fixes - Zero compilation errors

---
Part of the nself ecosystem - Backend infrastructure made simple