# VaultPanel Documentation

URL: https://docs.vaultpanel.net/

> Install VaultPanel, connect Linux servers and run websites, apps, databases, DNS, email and backups from one panel, with guides and API, CLI and SDK reference.

VaultPanel is a web control panel for Linux servers. Connect a server, then deploy and run production
websites and applications with their domains, databases, SSL certificates, process management,
monitoring, backups and security, without hand-editing server configuration. These docs cover
version 0.3.0.

## Install

On a fresh Ubuntu 22.04, 24.04 or 26.04, or Debian 12 or 13 server, as root.

### Update the system and install the required packages

Before running the installer, bring the system up to date and make sure `curl`, `wget` and `sudo` are
installed. The install command needs them.

```bash
apt update && apt -y upgrade && apt -y install curl wget sudo
```

### Download, check and run the installer

Choose your system and the database server for your websites and apps, then run the command.

| System | `DB_ENGINE` (the first is the default) |
| --- | --- |
| Ubuntu 26.04 LTS | `MARIADB_12.3` (MariaDB 12.3), `MARIADB_11.8` (MariaDB 11.8) |
| Ubuntu 24.04 LTS | `MARIADB_12.3` (MariaDB 12.3), `MARIADB_11.4` (MariaDB 11.4), `MARIADB_10.11` (MariaDB 10.11) |
| Ubuntu 22.04 LTS | `MARIADB_11.4` (MariaDB 11.4), `MARIADB_10.11` (MariaDB 10.11), `MARIADB_10.6` (MariaDB 10.6) |
| Debian 13 | `MARIADB_12.3` (MariaDB 12.3), `MARIADB_11.8` (MariaDB 11.8) |
| Debian 12 | `MARIADB_12.3` (MariaDB 12.3), `MARIADB_11.4` (MariaDB 11.4), `MARIADB_10.11` (MariaDB 10.11) |

`DB_ENGINE=NONE` installs no database server. Copy the current checksum from https://github.com/VaultPanel/packages:

```bash
curl -sS https://installer.vaultpanel.net/v2/install.sh -o install.sh; \
echo "<checksum from github.com/VaultPanel/packages> install.sh" | \
sha256sum -c && sudo DB_ENGINE=MARIADB_12.3 bash install.sh
```

The panel then runs on port 8090 over HTTPS. [Read the installation guide](https://docs.vaultpanel.net/getting-started/installation)
for options, the database choice and what the installer changes on the server.

## Get started

- [Introduction](https://docs.vaultpanel.net/getting-started/introduction)
- [Installation](https://docs.vaultpanel.net/getting-started/installation)
- [Quick start](https://docs.vaultpanel.net/getting-started/quick-start)

## Guides

- [Servers](https://docs.vaultpanel.net/guides/servers)
- [Websites](https://docs.vaultpanel.net/guides/websites)
- [Applications](https://docs.vaultpanel.net/guides/applications)
- [Databases](https://docs.vaultpanel.net/guides/databases)
- [DNS & Email](https://docs.vaultpanel.net/guides/dns-and-email)
- [Backups & Automation](https://docs.vaultpanel.net/guides/backups-and-automation)
- [Security](https://docs.vaultpanel.net/guides/security)
- [Hosting & Billing](https://docs.vaultpanel.net/guides/hosting-and-billing)
- [AI Assistant](https://docs.vaultpanel.net/guides/ai-assistant)

## Build on VaultPanel

- [API Reference](https://docs.vaultpanel.net/api-reference)
- [CLI Reference](https://docs.vaultpanel.net/cli)
- [JavaScript SDK](https://docs.vaultpanel.net/developers/sdk)
- [Plugins](https://docs.vaultpanel.net/developers/plugins)

## Resources

- [Best practices](https://docs.vaultpanel.net/best-practices)
- [Troubleshooting](https://docs.vaultpanel.net/troubleshooting)
- [Changelog](https://docs.vaultpanel.net/changelog)
