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

# Installation & Self-Hosting

> Production and trial deployment options via Docker Compose and Kubernetes Helm charts.

# Nucleus Core Banking — Installation Guide

## Quick Start (Trial Deployment)

Run the complete platform locally with a single command:

```bash theme={null}
docker compose -f nucleus-trial.yml up
```

This provisions:

* **Nucleus Engine** — `https://localhost:8443` (Core banking REST API)
* **Staff Console** — `http://localhost:3000` (Branch operations, till management, loans, GL, admin)
* **Internet Banking** — `http://localhost:3001` (Customer-facing digital portal)
* **PostgreSQL / MariaDB** — `localhost:5432` / `localhost:3306`

### Default Login Credentials:

| User   | Username   | Password             | Role        |
| ------ | ---------- | -------------------- | ----------- |
| Admin  | `admin`    | `nucleus-trial-2026` | Super admin |
| Teller | `teller01` | `teller-2026`        | Teller      |

***

## Production System Requirements

| Component             | Minimum Specification          | Recommended (Enterprise / National)          |
| --------------------- | ------------------------------ | -------------------------------------------- |
| **Docker Engine**     | 24+                            | Latest LTS                                   |
| **CPU**               | 2 cores                        | 8+ cores                                     |
| **RAM**               | 4 GB                           | 16+ GB                                       |
| **Disk**              | 20 GB SSD                      | 200+ GB NVMe                                 |
| **Database**          | MariaDB 10.6+ / PostgreSQL 16+ | High-Availability Cluster with Read Replicas |
| **Java (Standalone)** | OpenJDK 21 LTS                 | OpenJDK 21 LTS                               |

***

## Production Docker Compose Configuration

```bash theme={null}
# 1. Clone your configuration repository
git clone git@github.com:your-org/nucleus-infra.git
cd nucleus-infra

# 2. Configure production secrets in .env
cp .env.example .env
chmod 600 .env

# 3. Pull and launch containers
docker compose -f docker-compose.prod.yml up -d
```

Verify the health of the engine:

```bash theme={null}
curl -fks https://core.bank.yourdomain.com/nucleus/actuator/health
```
