Skip to Content
BytePanelBytePanel

Installation

Install the BytePanel panel with Docker Compose or the Debian and Ubuntu install script.

There are two ways to install the panel:

  • Docker Compose: runs the panel, Postgres and Redis together, and runs database migrations every time the panel starts. Recommended.
  • Install script: installs a release directly on Debian or Ubuntu.

You'll need a domain name pointing at the server, for example panel.example.com. The panel needs about 1 GB of memory. Game servers run on separate nodes, but a node can be the same machine.

Docker Compose

You'll need Docker with the Compose plugin, and a reverse proxy for HTTPS such as Caddy or nginx.

Get the code

git clone https://github.com/NodeByteHosting/BytePanel.git
cd BytePanel

Configure it

Copy the example environment file:

cp apps/web/.env.example apps/web/.env

Set at least these values in apps/web/.env:

BETTER_AUTH_SECRET=   # generate with: openssl rand -base64 32
BETTER_AUTH_URL=https://panel.example.com

DATABASE_URL and REDIS_URL are set by Docker Compose, so leave them as they are. See Configuration for every option.

Start it

Choose a Postgres password and start everything:

export POSTGRES_PASSWORD=$(openssl rand -hex 24)
echo "POSTGRES_PASSWORD=$POSTGRES_PASSWORD" > .env
docker compose up -d --build

The panel listens on port 3000.

Put it behind HTTPS

Point your reverse proxy at localhost:3000. With Caddy, this is the whole config:

Caddyfile
panel.example.com {
  reverse_proxy localhost:3000
}

Create the admin account

Open your panel URL and sign up. The first account becomes the super admin, and sign-up closes after that unless you use built-in billing.

Install script

On a fresh Debian or Ubuntu server, run as root:

bash <(curl -fsSL https://raw.githubusercontent.com/NodeByteHosting/BytePanel/main/install-scripts/web/debian-ubtuntu.sh)

The script installs Bun, Redis and nginx, downloads the latest panel release to /var/www/BytePanel and builds it. To install a specific version, set PANEL_VERSION=1.2.0 first.

Then follow Finish the script install to connect a database, start the panel and add HTTPS.

Next steps

  1. Add a node so the panel has somewhere to run servers.
  2. Go to Admin → Nests and click Sync built-in games, or import your own eggs.
  3. Create a plan under Admin → Plans.
  4. Choose a billing system under Admin → Settings → Billing.
Edit on GitHub

On this page