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

# On-Premises Deployment

> Deploy Snapsec Suite within your private cloud, VPC, or bare-metal infrastructure.

Snapsec On-Premises allows organizations with strict data residency, compliance, or network isolation mandates to run the complete Snapsec platform entirely within their own infrastructure.

***

## Hardware & System Requirements

| Scale | Monitored Assets | CPU | RAM | Storage (SSD) |
| :- | :- | :- | :- | :- |
| **Starter** | Up to 1,000 | 4 vCPU | 16 GB | 100 GB NVMe |
| **Standard** | 1,000 – 10,000 | 8 vCPU | 32 GB | 500 GB NVMe |
| **Enterprise** | 10,000+ | 16+ vCPU | 64+ GB | 1 TB+ NVMe |

### Software Prerequisites

* **Operating System**: Ubuntu 22.04 LTS / 24.04 LTS, RHEL 8+, Debian 12, or Rocky Linux 9.
* **Container Runtime**: Docker Engine 24.0+ and Docker Compose v2.20+, or Kubernetes 1.28+.
* **Database**: PostgreSQL 15+ (bundled or external AWS RDS / Google Cloud SQL).
* **Cache & Queue**: Redis 7+ (bundled or external).
* **Reverse Proxy**: Nginx, Traefik, or Ingress-Nginx with valid TLS certificates.

***

## Quick Installation via Docker Compose

### 1. Download Deployment Bundle

```bash theme={null}
curl -fsSL https://get.snapsec.co/onprem/install.sh | bash
cd /opt/snapsec
```

### 2. Configure Environment Variables

Edit `/opt/snapsec/.env`:

```ini theme={null}
# Platform Configuration
SNAPSEC_FQDN=snapsec.internal.company.com
SNAPSEC_LICENSE_KEY=YOUR_ENTERPRISE_LICENSE_KEY

# Security & Secrets
SECRET_KEY_BASE=generate_with_openssl_rand_hex_32
POSTGRES_PASSWORD=secure_postgres_password
REDIS_PASSWORD=secure_redis_password

# Storage
DATA_STORAGE_PATH=/var/lib/snapsec/data
```

### 3. Initialize and Start Services

```bash theme={null}
docker compose pull
docker compose up -d
docker compose exec app snapsec-ctl migrate
```

### 4. Verify Installation

```bash theme={null}
docker compose ps
curl -k https://localhost/healthz
```

Open `https://snapsec.internal.company.com` in your browser and complete the initial administrator setup.

***

## Upgrade Procedure

To upgrade to the latest minor or patch release:

```bash theme={null}
cd /opt/snapsec
docker compose pull
docker compose down
docker compose up -d
docker compose exec app snapsec-ctl migrate
```

***

## Next Steps

> [card] [System Requirements](https://docs.snapsec.co/platform/system-requirements.md)
>
> Detailed sizing and network port matrix.

> [card] [Backup & Restore](https://docs.snapsec.co/platform/backup-and-restore.md)
>
> Procedures for database snapshots and disaster recovery.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.