Nuvix

Nuvix allows you to own your infrastructure completely. This guide covers deploying the full stack—Database, Auth, Storage, and Console—using Docker.

Prerequisites

Docker Engine (v20.10+)
Docker Compose (v2.0+)
Git

Setup

Clone the main repository.

git clone https://github.com/nuvix-dev/docker.git nuvix
cd nuvix

Environment Configuration

Copy the example configuration to a production .env file.

cp .env.example .env

Critical Variables

You must change these values in .env for a secure deployment:

# Security Keys (Generate strong random strings)
NUVIX_JWT_SECRET="<generate-random-string>"
NUVIX_ENCRYPTION_KEY="<generate-random-string>"
NUVIX_DATABASE_ENCRYPTION_KEY="<must-be-exactly-16-chars>" # e.g. "a1b2c3d4e5f6g7h8"

# Database Credentials
NUVIX_DATABASE_ADMIN_PASSWORD="<strong-db-password>"
NUVIX_DATABASE_PASSWORD="<strong-db-password>"

# Initial Admin User (Created on first run)
NUVIX_ADMIN_EMAIL="admin@yourdomain.com"
NUVIX_ADMIN_PASSWORD="<strong-admin-password>"

Deploy

Start the stack in detached mode.

docker compose up -d

Stack Components

server: Core API (Port 4000)
platform: Platform api (Port 4100)
postgres: Main Database (Port 5432)
redis: Cache & PubSub (Port 6379)
console: Console UI (Port 3000)

Verify

Check container status:

docker compose ps

Access the console at: http://<your-server-ip>:3000 (or your configured domain).

Updates

To update your instance:

git pull
docker compose pull
docker compose up -d

Self Hosting