> ## 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.

# Installation & Upgrade

> Step-by-step procedures for deploying, maintaining, and upgrading Snapsec Suite on-premises.

This guide covers deployment and maintenance procedures for the Snapsec self-hosted platform.

***

## Initial Installation

```bash theme={null}
# 1. Prepare installation directory
sudo mkdir -p /opt/snapsec && cd /opt/snapsec

# 2. Download official installer script
curl -fsSL https://get.snapsec.co/onprem/install.sh -o install.sh
chmod +x install.sh
sudo ./install.sh --version latest

# 3. Complete configuration prompts
# Provide your license key, FQDN, and database options

# 4. Start Snapsec services
sudo systemctl enable --now snapsec
```

***

## Upgrade Workflow

Snapsec releases regular monthly feature releases and patch updates. Upgrades are non-destructive and perform automatic schema migrations.

```bash theme={null}
# 1. Create pre-upgrade database backup
sudo snapsec-ctl backup --type full

# 2. Pull new container images
cd /opt/snapsec
sudo docker compose pull

# 3. Apply schema migrations and restart containers
sudo docker compose down
sudo docker compose up -d
sudo docker compose exec app snapsec-ctl migrate

# 4. Check cluster health status
sudo snapsec-ctl status
```

***

## Rollback Procedure

If a migration fails or an unexpected issue occurs:

```bash theme={null}
sudo docker compose down
# Revert docker-compose.yml image tags to previous version
sudo snapsec-ctl restore --file /var/backups/snapsec/pre-upgrade-backup.tar.gz
sudo docker compose up -d
```


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