Installation

Kuberfy installs on any standard Linux VPS (Ubuntu, Debian, AlmaLinux, Arch, etc.) using a single automated shell script that configures Docker, initializes Swarm, spins up Traefik, and deploys the control plane.

System Requirements

Resource	Minimum	Recommended
CPU	1 vCPU (x86_64 or arm64)	1+ vCPU
Memory (RAM)	512 MB RAM	1 GB+ RAM
Disk Space	5 GB SSD	10 GB+ SSD
Operating System	Ubuntu 22.04+ / Debian 12+	Ubuntu 24.04 LTS / Debian 12
Open Ports	`80`, `443`, `3000`	`80` (HTTP), `443` (HTTPS), `3000` (Dashboard)

One-Command Installation

Connect to your VPS via SSH as root (or with sudo privileges) and run:

curl -sSL https://kuberfy.pages.dev/install.sh | sudo sh

The script will prompt you for:

Admin Email: The initial administrator email address for login.
Domain Name (Optional): Your custom domain (e.g. kuberfy.yourdomain.com). If left empty, the server will default to your public IP.

Non-Interactive Installation

If you are provisioning a server with cloud-init or automated scripts, you can supply environment variables:

curl -sSL https://kuberfy.pages.dev/install.sh | \
  ADMIN_EMAIL=admin@yourdomain.com \
  KUBERFY_DOMAIN=kuberfy.yourdomain.com sudo sh

Available Environment Flags

Variable	Description	Default
`ADMIN_EMAIL`	Email address for initial admin user creation.	Interactive Prompt
`KUBERFY_DOMAIN`	Public domain for dashboard and Let's Encrypt certificates.	Server Public IP
`ACME_EMAIL`	Email used for Let's Encrypt certificate renewal notices.	`$ADMIN_EMAIL`

Initial Login

Once the installer finishes, it will print your server URL and a temporary password:

Example Output:

✔ Kuberfy is ready!
➜ URL: http://your-server-ip:3000 (or https://kuberfy.yourdomain.com)
➜ Email: admin@yourdomain.com
➜ Temporary Password: a1b2c3d4e5...

Open the URL in your browser, log in with your credentials, and change your password in the account settings.

Host CLI Wrapper

The installer automatically creates /usr/local/bin/kuberfy on your host. You can manage Kuberfy directly from the server terminal:

kuberfy --help