Skip to content

Install an app on a server

Installing an app means picking a server, choosing what to run, and deploying it. You can deploy from an App Template, where you fill in a short form, or deploy a Custom App from a raw Docker image you specify yourself.

Before you start

If the app uses a private container image, save your registry credentials first. We need a username and a password or token to pull it. Add those under Security in the Registries page.

Registry credentials

Deploy the app

Open the instance you want to run the app on, then select the Apps tab. Deploying starts from a split button: the primary New App button deploys from an App Template, and its dropdown offers Custom App for a raw Docker image you specify yourself. You can also start the same flow from the workspace Apps page in the sidebar.

An instance Apps tab with the New App button circled
Deploy an app from the instance Apps tab (New App, circled).

Deploy from an App Template

Select New App. This opens a dedicated page, not a popup. First you see a template picker, which you can filter by category. Pick a template to reach its deploy page, then fill in the form:

  1. Enter an app name. This is required.
  2. Set any environment overrides for the template's variables, and add extra environment variables if you need them.
  3. Set optional mount overrides.
  4. If the template exposes an HTTP port, enter a domain.
  5. Deploy it onto the instance.

Deploy a Custom App

Open the split button's dropdown and select Custom App. There is no template, so you provide the details directly: an app name, the image, environment variables, ports, and mounts. Then deploy it onto the instance.

Once the deployment finishes, the app appears in the list on the Apps tab with its status.

Private image

If the template pulls a private container image and the deployment does not start, check that your registry credentials are saved under Security in Registries.

Manage a running app

You control a deployed app from the Apps tab:

  • Start brings up an app that is stopped.
  • Stop shuts a running app down. It stays deployed, so you can start it again later.
  • Restart stops and starts the app in one step. Use it to apply a change or clear a stuck state.
  • View Logs shows the app's output.
  • Delete removes the app from the server.