Overview
Apps are managed software you run on your servers. You deploy an app and we set it up, instead of connecting to an instance and installing by hand. An app runs on one of your instances: it uses that machine's resources and stays there until you remove it.
There are two ways to create one:
- From an App Template: fill in a short form and we handle the setup.
- As a Custom App: deploy a raw Docker image you specify yourself.
Where apps live
You can work with apps from two places, both with the same tools:
- On an instance. Open a server and select the Apps tab to see the apps on that machine and deploy new ones.
- From the sidebar. The Apps page gives a workspace-wide view and the same controls.
Both use the same split button to create an app. The primary New App button deploys from an App Template. Its dropdown offers Custom App, a raw Docker image you specify yourself.
What you can do with an app
- Deploy a new app onto an instance, either from an App Template or as a Custom App from a raw Docker image.
- Start an app that is stopped.
- Stop a running app.
- Restart an app to apply changes or clear a bad state.
- View Logs to see the app's output.
- Delete an app to remove it from the server.
Two ways to create an app
- From an App Template. The New App button opens a dedicated page where you pick a template, then fill in a deploy form: a required app name, environment overrides for the template's variables, extra environment variables, optional mount overrides, and, if the template exposes an HTTP port, a domain.
- As a Custom App. The Custom App dropdown entry deploys a raw Docker image with no template. You provide the app name, the image, environment variables, ports, and mounts.
Feature at a glance
| Feature | What it does |
|---|---|
| App Templates | Fill in a short deploy form instead of configuring the software from scratch. |
| Custom Apps | Deploy a raw Docker image you specify yourself, with no template. |
| Per-instance placement | Each app runs on a specific server you choose, listed on that server's Apps tab. |
| Lifecycle controls | Start, stop, restart, view logs, and delete an app whenever you need to. |
| Private images | Pull software from a private container registry using saved credentials. |
Private images need registry credentials
Some apps pull a private container image. Save the registry username and password or token under Security in the Registries page first. Without those credentials, the image cannot be pulled and the deployment will not start.