Skip to content
VirtlixCP

Documentation / Getting Started

Installation

Before you start

  • A server that meets the requirements, with root access
  • A license key from your client area
  • Three DNS names pointing at the server's IP: panel.example.com, admin.panel.example.com and api.panel.example.com

Run the installer

curl -fsSL https://virtlix.com/install-bm.sh -o install-bm.sh
bash install-bm.sh key=YOUR-LICENSE-KEY domain=panel.example.com

The install takes about ten minutes. It ends with the admin username and password. The full log is in /var/log/virtlix-bm-install.log.

Options

Option Default What it does
key= required Your license key
domain= required The client area domain
email= admin@domain Email of the first admin
site_name= VirtlixCP Name shown in the panel
hypervisor=no yes Don't add this server as a KVM hypervisor
vps_network= routed routed, bridge:br0, direct:eth0 or nat

After the install

  1. Sign in at admin.panel.example.com.
  2. Turn on SSL under System, Settings. See SSL Issues if it fails.
  3. Follow the Setup checklist at the bottom of the admin menu, described in First Steps.

The license locks to the server's IP the first time it is used. To move to another server, see Moving the Panel to a New Server.