> ## Documentation Index
> Fetch the complete documentation index at: https://nenyax.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Get Nenyax running in under 5 minutes.

# Quick Start

Choose your deployment method:

| Method                                  | Best for                    | Custom Agents |
| --------------------------------------- | --------------------------- | ------------- |
| [Self-Hosted (VPS)](#self-hosted)       | Production, full features   | ✅             |
| [Railway (One-Click)](#railway)         | Quick demo, standard agents | ❌             |
| [Local Development](#local-development) | Development, contributing   | ✅             |

***

## Self-Hosted

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

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

```bash theme={null}
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](/self-hosting) for step-by-step instructions with Google Cloud, VPS provider recommendations, and management commands.

***

## Railway

[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/nenyax)

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

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

<Warning>
  Custom agents (code editor, Docker containers, AI coding assistant) are **not supported** on Railway. Use [Self-Hosted](/self-hosting) for full features.
</Warning>

***

## Local Development

For development and contributing. Requires [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed and running.

**No `.env` files needed** — all defaults are hardcoded for local dev.

### 1. Clone

```bash theme={null}
git clone https://github.com/Nenyax-AI/Nenyax.git
cd Nenyax
```

### 2. Start infrastructure

```bash theme={null}
docker compose up -d postgres minio
```

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

### 3. Start services

```bash theme={null}
# 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](http://localhost:3000) |
| Backend API | [http://localhost:8000](http://localhost:8000) |
| Voice Agent | Connected to LiveKit                           |
| PostgreSQL  | localhost:5434                                 |
| MinIO       | [http://localhost:9002](http://localhost:9002) |

### 4. Configure API keys

Open [http://localhost:3000](http://localhost:3000), create an account, then go to **Settings → API Keys** and add:

1. **LiveKit** — URL, API Key, API Secret ([LiveKit Cloud](https://cloud.livekit.io))
2. **Google AI** — API Key for Gemini ([Google AI Studio](https://aistudio.google.com))
3. **Resemble AI** — API Key for TTS ([Resemble AI](https://resemble.ai))
4. **STT** — AssemblyAI or Deepgram API key

### 5. Build custom agent base image (optional)

Only needed if you want to use custom agents locally:

```bash theme={null}
docker build -t nenyax-agent-base:latest -f agent/Dockerfile.base agent/
```

### Useful commands

```bash theme={null}
# View Docker logs
docker compose logs -f postgres minio

# Stop infrastructure
docker compose down

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

<Tip>
  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](/configuration/docker).
</Tip>

For more details on local development, see the [Local Development Guide](/local-development).

***

## Next Steps

<CardGroup cols={2}>
  <Card title="Self-Hosting Guide" icon="server" href="/self-hosting">
    Full deployment guide with Google Cloud walkthrough.
  </Card>

  <Card title="Agent Configuration" icon="user-gear" href="/features/agents">
    Create and configure your first voice agent.
  </Card>

  <Card title="Custom Agents" icon="code" href="/features/custom-agents">
    Build custom agents with the code editor and AI assistant.
  </Card>

  <Card title="LiveKit Setup" icon="signal" href="/configuration/livekit">
    Get your LiveKit Cloud credentials.
  </Card>
</CardGroup>