PanelAlpha Documentation
Back Home
Live Demo Get Started

Installation

Documentation

    # Installation

    • Before You Begin
    • Download and Install
      • Installer Options
      • Lost API Token
    • Connect Through the PanelAlpha Installation Wizard
    • Next Steps
    • Troubleshooting

    This page explains how to install PanelAlpha Engine 1.x on a server and connect it to PanelAlpha Single Server or Multi Server.

    # Before You Begin

    1. Use a fresh server that meets the system requirements. Do not install the Engine on the server that runs PanelAlpha.
    2. Make sure you can log in to the server over SSH as root.
    3. Have your PanelAlpha license key ready. It is in the product details under Licenses (opens new window) in the client area.
    4. Make sure the server can reach the internet. The installer downloads packages and Docker images.

    # Download and Install

    The PanelAlpha installation wizard shows the same commands. See Access the Wizard.

    1. Log in to the server as root:

      ssh root@your-server-ip
      
    2. Download the installer:

      wget -N -P /opt/panelalpha https://license.panelalpha.com/engine-installer.sh
      
    3. Run the installer with your license key:

      bash /opt/panelalpha/engine-installer.sh --key 'YOUR_LICENSE_KEY'
      

      Replace YOUR_LICENSE_KEY with your key from the client area.

    4. Wait for the installer to finish. At the end it prints the API URL and the API Token. Copy both. You need them to add the server in PanelAlpha.

    The installer sets up Docker, the Engine containers, the CSF firewall, monit and some kernel settings. If the server has a public IP address, it also gets a Let's Encrypt certificate for that address. The Engine is installed in /opt/panelalpha/shared-hosting.

    # Installer Options

    Option What it does
    --key <key> Your PanelAlpha license key. Required.
    --version <version> Installs a given Engine version instead of the latest.
    --no-local-ip If the server's own address is private, uses the public IPv4 address (looked up online) for the API URL and the default IP.
    --enable-nat For servers behind 1:1 NAT, for example on some cloud providers. The Engine looks up the public IPv4 address for each private address.
    --debug Prints more output. Use it when you send the output to support.

    # Lost API Token

    If you did not copy the token, create a new one on the Engine server:

    docker compose -f /opt/panelalpha/shared-hosting/docker-compose.yml exec -T core php artisan api-tokens:create panelalpha --short
    

    See Artisan Commands for listing and deleting tokens.

    # Connect Through the PanelAlpha Installation Wizard

    If you install PanelAlpha and PanelAlpha Engine together, you can add the Engine in step 3 of the PanelAlpha wizard, Add your first server.

    1. Select PanelAlpha Engine as the server type.
    2. Click Install PanelAlpha Engine to see the installer commands, and run them on the Engine server as described above.
    3. Paste the API URL and the API Token from the installer output.
    4. Click Test Connection. When it shows Finished, continue to the next step.

    # Next Steps

    1. Add the server in PanelAlpha, if you did not do it in the wizard.
    2. Set up a plan that uses the server.
    3. Check the Firewall (CSF) rules, and set up Outgoing Mail so sites can send email.

    # Troubleshooting

    If the installer stops with an error, see Troubleshooting.