Skip to content
Agency

Agency: Getting Started

Set up your own client hosting business from the desktop app: install the Agency server, connect, set up your authenticator and add more computers.

Agency is not on sale yet. This guide describes the setup for founding and early-access customers. The Agency screen appears in the desktop app only when you have an Agency key.

Agency lets you sell hosting to your own clients under your own brand. It has three parts:

PartWhere it livesWho uses it
The desktop appYour computerYou. Everything an owner does happens here: deploying client sites, billing setup, branding, approvals
The Agency serverA VPS you ownStores your clients, orders, invoices and sites, and serves the client portal. It has no admin website for you to use
The client portalOne web address on your own domainYour clients: they order, pay, see their sites and logins, and download invoices

Your clients never see DeployOS. They see your name, colour and domain.

What you need

  • An Agency key, activated in the desktop app (Settings → License). Without one the Agency menu entry is hidden.
  • A VPS, or one of your existing DeployOS servers, for the Agency server.
  • One address pointing at it, for example clients.youragency.com. Your clients open it, and the desktop app uses the same address to run your Agency. There is no separate admin website or second domain to set up.

1. Install the Agency server

  1. Open Agency and press Install on a server.
  2. Choose a brand-new VPS (give its address and SSH login) or one of your DeployOS-managed servers (it then shares that server's reverse proxy).
  3. Enter your clients' address and your email. The email becomes your Owner login.
  4. Press install. DeployOS connects over SSH, copies the installer, fetches the Agency images, runs it, and waits for your Agency to answer.

When it finishes you see your Owner login (email and a generated password). Save it; DeployOS also keeps a copy in your computer's keychain. The app connects itself to the new server, so you do not need to open the web panel.

2. Set up your authenticator

Approving sensitive actions (such as restoring a client's backup) needs a 6-digit code from an authenticator app.

  1. On the Agency card press Authenticator → Set up authenticator.
  2. Scan the QR code with an authenticator app (Google Authenticator, 1Password, Authy), or type the key shown under it.
  3. Enter the 6-digit code and press Confirm.

You do this once. It works on Agency servers this app installed, because those are the ones whose Owner login the app has saved. For an Agency you connected with a link, ask the computer that installed it to set it up.

3. Connect another computer

On a connected computer open Agency → Access and press Make a connection link. On the other computer open Agency, press Connect existing, and paste the link. A link works once and expires soon. Computers you no longer want can be disconnected from the same Access tab.

Next