Quick Start

Choose your deployment method:

Method	Best for	Custom Agents
Self-Hosted (VPS)	Production, full features	✅
Railway (One-Click)	Quick demo, standard agents	❌
Local Development	Development, contributing	✅

Self-Hosted

Recommended for production. This is the only deployment method that supports all features including custom agents, Docker sandboxes, and the AI coding assistant.

SSH into any Linux VPS (4GB+ RAM) and run:

sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/Nenyax-AI/Nenyax/master/install.sh)"

That’s it. The script installs Docker, generates credentials, sets up HTTPS, and starts everything. Open https://<your-ip> → create account → add API keys in Settings. See the full Self-Hosting Guide for step-by-step instructions with Google Cloud, VPS provider recommendations, and management commands.

Railway

One-click deploy. Railway auto-provisions PostgreSQL and wires all services.

Click the button → Deploy
Wait for all services to go green (~3-5 min)
Open the frontend URL → sign up → add API keys in Settings

Custom agents (code editor, Docker containers, AI coding assistant) are not supported on Railway. Use Self-Hosted for full features.

Local Development

For development and contributing. Requires Docker Desktop installed and running. No .env files needed — all defaults are hardcoded for local dev.

1. Clone

git clone https://github.com/Nenyax-AI/Nenyax.git
cd Nenyax

2. Start infrastructure

docker compose up -d postgres minio

This starts PostgreSQL (port 5434) and MinIO (port 9002). The nenyax database is created automatically.

3. Start services

# Backend (terminal 1)
cd backend && python -m venv venv && venv/bin/activate && pip install -e .
uvicorn app.main:app --reload

# Frontend (terminal 2)
cd frontend && npm install && npm run dev

# Agent (terminal 3)
cd agent && python -m venv venv && venv/bin/activate && pip install -e .
python agent.py dev

Service	URL
Frontend	http://localhost:3000
Backend API	http://localhost:8000
Voice Agent	Connected to LiveKit
PostgreSQL	localhost:5434
MinIO	http://localhost:9002

4. Configure API keys

Open http://localhost:3000, create an account, then go to Settings → API Keys and add:

LiveKit — URL, API Key, API Secret (LiveKit Cloud)
Google AI — API Key for Gemini (Google AI Studio)
Resemble AI — API Key for TTS (Resemble AI)
STT — AssemblyAI or Deepgram API key

5. Build custom agent base image (optional)

Only needed if you want to use custom agents locally:

docker build -t nenyax-agent-base:latest -f agent/Dockerfile.base agent/

Useful commands

# View Docker logs
docker compose logs -f postgres minio

# Stop infrastructure
docker compose down

# Full reset (deletes data)
docker compose down -v

You can also run all 5 services in Docker with docker compose up -d --build. This uses ports 4200 (frontend) and 4201 (backend) instead. See Docker Configuration.

For more details on local development, see the Local Development Guide.

Next Steps

Self-Hosting Guide

Full deployment guide with Google Cloud walkthrough.

Agent Configuration

Create and configure your first voice agent.

Custom Agents

Build custom agents with the code editor and AI assistant.

LiveKit Setup

Get your LiveKit Cloud credentials.

Getting Started

Architecture

Configuration

Features

Quick Start

Quick Start

Self-Hosted

Railway

Local Development

1. Clone

2. Start infrastructure

3. Start services

4. Configure API keys

5. Build custom agent base image (optional)

Useful commands

Next Steps

Self-Hosting Guide

Agent Configuration

Custom Agents

LiveKit Setup

​Quick Start

​Self-Hosted

​Railway

​Local Development

​1. Clone

​2. Start infrastructure

​3. Start services

​4. Configure API keys

​5. Build custom agent base image (optional)

​Useful commands

​Next Steps

Self-Hosting Guide

Agent Configuration

Custom Agents

LiveKit Setup

Quick Start

Self-Hosted

Railway

Local Development

1. Clone

2. Start infrastructure

3. Start services

4. Configure API keys

5. Build custom agent base image (optional)

Useful commands

Next Steps