# Frequently asked questions

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

> Short answers to common questions about installing, running, securing and extending VaultPanel, with links to the full guides.

Short answers, each with a link to the page that explains more. If your question is about an error, start with [Troubleshooting](https://docs.vaultpanel.net/troubleshooting).

## General

### What is VaultPanel?

A web control panel for Linux servers. You connect a server, then deploy and run websites and applications with their domains, databases, SSL, process management, monitoring, backups and security, with little manual Linux administration. See [Introduction](https://docs.vaultpanel.net/getting-started/introduction).

### How does the panel manage my servers?

A small agent runs on each server and connects out to the panel over HTTPS. The panel sends signed jobs from a fixed catalog of operations, and the agent checks the signature and the parameters before it runs fixed commands without a shell. There is no endpoint that runs arbitrary commands. See [How it works](https://docs.vaultpanel.net/getting-started/how-it-works).

### Do my servers need an open inbound port for the agent?

No. Agents connect out to the panel and long-poll it for work, so servers need no inbound port for VaultPanel. The panel's own server needs its panel port (8090 by default) reachable by the people and agents that use it.

### I used NodePanel. Can I upgrade to VaultPanel?

NodePanel was renamed to VaultPanel in 0.2.0. Nothing converts a NodePanel install, its agents or its tokens: remove NodePanel, install VaultPanel and add each server again. See the [Changelog](https://docs.vaultpanel.net/changelog).

## Installation and updates

### Which systems are supported?

The installer supports Ubuntu 22.04, 24.04 and 26.04, and Debian 12 and 13, with systemd, run as root. 2 GB of memory or more is recommended, and a fresh server is best. See [System requirements](https://docs.vaultpanel.net/getting-started/system-requirements).

### Do I need a domain to install the panel?

No. The panel serves HTTPS on its port from the first start with a self-signed certificate, and servers can be added safely without a domain because agent install commands pin that certificate. Add a domain later for a certificate browsers trust. See [Panel HTTPS and domain](https://docs.vaultpanel.net/getting-started/panel-https-and-domain).

### Which database server do my websites and apps get?

MariaDB, chosen with `DB_ENGINE` when you install (12.3, 11.8, 11.4, 10.11 or 10.6, depending on the system), or `DB_ENGINE=NONE` for none. A server that already has MariaDB or MySQL keeps it. MySQL 8.4 and 8.0 come in a later version. The panel's own database is separate. See [Installation](https://docs.vaultpanel.net/getting-started/installation).

### How do I update VaultPanel?

Run `sudo vaultpanel update`. It backs the panel up, installs the newest `vaultpanel` package, updates the database and restarts. `sudo apt upgrade` does the same with the system's other packages, and `sudo vaultpanel rollback` reverses the last update. See [Updating](https://docs.vaultpanel.net/getting-started/updating).

### How do I back up the panel itself?

A timer backs up the panel's database, settings, secret key and certificate every day, and `sudo vaultpanel backup` makes one now. Keep a copy off the server. Website, app and database backups are separate, under **Backups** in the panel. See [Backing up the panel](https://docs.vaultpanel.net/getting-started/backing-up-the-panel).

## Servers and agents

### Does the agent run as root?

The agent that talks to the panel runs as its own `vaultpanel-agent` user with no capabilities (agent 0.36.0 and newer). A separate root helper on a local socket runs only jobs and terminal sessions whose signature it has checked itself. See [Agent](https://docs.vaultpanel.net/developers/agent).

### How do I update the agents on my servers?

When the panel has a newer agent than a server, the server's page shows **Update agent**. A bulk action updates many servers at once and skips the ones already current. Agents older than 0.7.0 need the upgrade command shown on their page once, and so do servers still on the old Node.js agent: the command moves them to the current agent and keeps their registration. See [Server groups](https://docs.vaultpanel.net/guides/servers/server-groups) and [Moving from the Node.js agent](https://docs.vaultpanel.net/guides/servers/connecting-servers#moving-from-the-nodejs-agent).

### Do my servers need Node.js?

Not for the agent. It is one program written in Rust, for x86-64 and arm64 servers, with nothing else to install. Node.js is only needed on servers that run Node.js apps or PM2, installed system-wide. See [Connecting servers](https://docs.vaultpanel.net/guides/servers/connecting-servers#requirements).

### Can I open a shell on a server from the panel?

Owners can open a root terminal in the browser, from **Terminal** in the sidebar or a server's **Terminal** tab. Sessions can be recorded and replayed. See [Terminal](https://docs.vaultpanel.net/guides/servers/terminal).

## Websites and SSL

### What kinds of websites can I host?

Static websites (with a single-page app setting), PHP sites on PHP-FPM with a PHP version per site (7.4 and 8.0 to 8.5), and reverse proxies to an app. NGINX is set up for you. See [Websites](https://docs.vaultpanel.net/guides/websites).

### Does VaultPanel support .htaccess files?

Yes, through Apache behind NGINX. Install Apache from the server's **Web stack** card, then turn on **Use .htaccess files** in a website's settings. Staff can also add custom NGINX rules. See [NGINX rules and .htaccess](https://docs.vaultpanel.net/guides/websites/nginx-and-htaccess).

### Which certificates can I use?

Free Let's Encrypt certificates, certificates you upload, and Let's Encrypt wildcard certificates through the panel's own DNS zones, Cloudflare or Namecheap. See [SSL certificates](https://docs.vaultpanel.net/guides/websites/ssl-certificates).

### Can I install WordPress in one step?

Yes. The app installer sets up WordPress, Joomla, Drupal or Laravel with its database. See [CMS installer](https://docs.vaultpanel.net/guides/websites/cms-installer).

### Does email hosting include webmail or spam filtering?

Not yet. Email hosting runs Postfix, Dovecot and OpenDKIM with mailboxes, forwarders and DKIM-signed mail. Webmail, spam and virus filtering, autoresponders and catch-all addresses are planned. See [Email hosting](https://docs.vaultpanel.net/guides/dns-and-email/email-hosting) and the [Roadmap](https://docs.vaultpanel.net/roadmap).

## Apps and databases

### Which languages can I deploy?

Node.js, Python, Go and Ruby apps, and PHP websites, deploy from Git into release folders and run under PM2 as their own Linux user. They can be rolled back, deployed on every push through signed webhooks, and capped on CPU and memory. Node.js apps reload without downtime. See [Applications](https://docs.vaultpanel.net/guides/applications).

### Can I run Docker containers?

Yes, from public images, with ports, named volumes, environment variables and limits. An update rolls back automatically when the new container does not start. Private registries and Compose files are planned. See [Containers](https://docs.vaultpanel.net/guides/applications/containers).

### Are PostgreSQL and Redis supported for my apps?

Not yet. Databases are MariaDB today; PostgreSQL and Redis are shown as **Coming later** on the **Databases** page. See [Databases](https://docs.vaultpanel.net/guides/databases).

### Where can backups be stored?

On the server, in an S3-compatible bucket (Amazon S3, Backblaze B2, Wasabi, Cloudflare R2, MinIO), or on another server over SFTP. See [Backup storage](https://docs.vaultpanel.net/guides/backups-and-automation/backup-storage).

## Security

### Does the panel run as root?

No. The API and the worker run as the unprivileged `vaultpanel` user inside a systemd sandbox. Only the step that connects the panel's own server, before the API starts, runs as root. See [Security](https://docs.vaultpanel.net/guides/security).

### Can I require two-factor sign-in?

Yes. Under **Security > Authentication**, owners can require it for **Owners and admins** or **Everyone**. Two-factor sign-in comes with 10 one-time recovery codes. See [Sign-in and two-factor](https://docs.vaultpanel.net/guides/security/sign-in-and-two-factor).

### Can I limit who can reach the panel?

Yes. **Panel access by address** accepts people only from the addresses and networks you list. With **Staff only**, hosting customers still sign in from anywhere. See [Panel access](https://docs.vaultpanel.net/guides/security/panel-access).

### What does the AI assistant send to its provider?

The questions, and what it reads to answer them: status, log lines and process lists. Environment variable values, database passwords and keys are never given to it. To keep that data on your servers, use the free model on the panel's own server or a self-hosted OpenAI-compatible service. See [AI assistant](https://docs.vaultpanel.net/guides/ai-assistant).

## Hosting and billing

### Can I host customers on VaultPanel?

Yes. Hosting plans set how many websites, apps, databases and cron jobs a customer may have, their disk space and caps on each app. Customers sign in to a panel that shows only their own account. See [Hosting and billing](https://docs.vaultpanel.net/guides/hosting-and-billing).

### Does VaultPanel take payments?

No. A billing system such as WHMCS, Blesta or your own charges customers and manages their accounts through the billing API. A WHMCS module is available; there is no Blesta module yet. See [Billing API](https://docs.vaultpanel.net/guides/hosting-and-billing/billing-api) and [WHMCS](https://docs.vaultpanel.net/guides/hosting-and-billing/whmcs).

## Licensing

### Is VaultPanel free?

VaultPanel is proprietary software, free to use under the VaultPanel License. You may install and use it, also to host your customers, but not copy, change, resell or redistribute it.

### Under which license are the SDK, CLI and WHMCS module?

MIT. The SDK, the CLI, the WHMCS module and the example plugin each come with their own MIT license, so other software can be built with them.

### Where do I report a bug or a security issue?

Report bugs in the issues of [VaultPanel/packages](https://github.com/VaultPanel/packages) on GitHub, which holds the installer and the packages. Never report a vulnerability in a public issue: use **Security > Report a vulnerability** on the same repository, with what an attacker can do, the steps to reproduce it and your versions (`vaultpanel version`).

## API and integrations

### Is there an API?

Yes, a REST API at `/api/v1`. Scripts authenticate with API tokens (`vpt_…`) that act as the person who made them, narrowed to the scopes they were given. See the [API reference](https://docs.vaultpanel.net/api-reference) and [API tokens](https://docs.vaultpanel.net/api-reference/api-tokens).

### Is there a command-line tool or SDK?

Yes. `@vaultpanel/sdk` is a JavaScript client for the API, and the `vaultpanel` command-line tool is built on it. On the panel's server, the `vaultpanel` command also passes panel commands to the CLI. See the [CLI reference](https://docs.vaultpanel.net/cli) and [SDK](https://docs.vaultpanel.net/developers/sdk).

### Can I extend the panel?

Yes, with plugins: separate programs that an owner approves, which then work through the API with their own token, receive signed events and can add a page to the sidebar. See [Plugins](https://docs.vaultpanel.net/developers/plugins).
