Offer Deplo to your customers

Ship Deplo as a VPS template that installs itself on first boot, with the customer's account already in it.

The setup we recommend to every hosting provider: a clean base image, one command at first boot, and an address you can predict. The customer signs in with the email and password from your welcome email. No log to read, no key to copy.

Create the base template

Start from a clean, minimal image:

Requirement
OSUbuntu 24.04 LTS, 26.04 LTS · Debian 12, 13
Architecturex86-64 or arm64, with systemd
Ports80 and 443 open from the internet
Smallest plan2 cores, 4 GB of RAM, 30 GB of disk
Comfortable plan4 cores, 8 GB of RAM

More in what you need.

Run the installer on first boot

Chain the installer to your provisioning, right after the operating system install:

#cloud-config
runcmd:
  - curl -fsSL https://deplo.build/install.sh | bash -s -- --yes --owner-email [email protected] --owner-password '<temporary password>'
  • --owner-email is the customer's, the one on their order.
  • --owner-password is a temporary one, at least 8 characters, new for every order: the service password your billing (WHMCS, for example) already generates.
  • At the first sign-in Deplo makes the customer replace it. Until then the account can do nothing else.
  • --domain panel.customer-domain.com (optional) starts the panel on the customer's own domain, with a Let's Encrypt certificate. If your order form asks for a domain, pass it: the customer never has to move the panel later. Its DNS must point at the VM; until it does, the generated deplo.site address answers.

Treat the temporary password as seen

The install transcript hides it, but it is readable in the process list while the install runs, and cloud-init keeps it in the stored user data. Tell the customer to sign in right away: the first sign-in replaces it.

The cloud-init version works as is on any panel that accepts cloud-init user data: Proxmox VE, SolusVM 2, Convoy, OpenStack, CloudStack. On VirtFusion, add it as a server provisioner, in Bash or cloud-init YAML.

On Virtualizor: the root password as a fallback

A recipe can pass only the root password: {{username}} is the customer's email and {{root_pass}} their root password, so use --owner-email '{{username}}' --owner-password '{{root_pass}}'. It works, but until the first sign-in the root password also opens the panel. Tell the customer to sign in right away.

Build the customer's address

With --domain, the address is that domain: https://panel.customer-domain.com.

Without it, the panel answers on deplo.site, a wildcard DNS where a name carrying an IPv4 in hexadecimal resolves to that IP. Each octet becomes two hex digits, so 203.0.113.10 gives:

https://deplo-cb00710a.deplo.site
IP=203.0.113.10
echo "https://deplo-$(printf '%02x' ${IP//./ }).deplo.site"

An IPv6-only VM gets its IPv6 instead: 2001:db8::10 gives deplo-v6-2001-db8--10.deplo.site.

Send it

  • Where: in the welcome email or the VPS detail page, next to the email and temporary password.
  • When: the install takes a few minutes after boot. Until then the address does not answer.
  • What they see: a sign-in page, then a short setup that replaces the temporary password and names their team.

The customer can later move the panel to their own domain from Settings -> Deplo: see the panel's own address.

Use your own wildcard domain

deplo.site is optional. To put the panel under your brand, run wildcard DNS on a domain of yours and pass the VM's hostname on it, built the same way, with --domain:

curl -fsSL https://deplo.build/install.sh | bash -s -- \
  --yes --owner-email [email protected] --owner-password '<temporary password>' \
  --domain deplo-cb00710a.example-vps.net

The panel answers on https://deplo-cb00710a.example-vps.net, with a Let's Encrypt certificate.

Use a dedicated domain

Keep the wildcard apart from your main domain, the way Deplo keeps deplo.site apart from deplo.build. Customer servers answer on it, so abuse reports, blocklists and cookies stay away from your website and your billing panel.

  • We recommend running your own nip.io: it resolves the hex form of the IP out of the box. Set it as the nameserver of example-vps.net at your registrar.
  • Even better, host it on Deplo itself, on a server of yours. It is a DNS server, so that server needs port 53 open on UDP and TCP.
  • The generated deplo.site address stays on as a backup. The customer can turn it off in Settings -> Deplo -> Advanced, Backup address.

A different setup in mind?

Our technical team is happy to review it: write to [email protected].

See also

Did this page help you?

On this page