1. Git repository or Docker image
You must ensure the application you want to host exists within a Git repository or Docker image. If you use a public Git repository, you need the URL and branch of the repository. If you want to use a private Git repository, you must select a Git service provider and repository from your account. You can choose from any (or all) of the following: If you use a public Docker image you need the path to the Docker image. If you want to use a private Docker image, you must add your registry credentials within username > Company settings > Registry credentials. You can choose from any (or all) of the following registries:- GitHub (ghcr.io)
- GitLab (registry.gitlab.com)
- Docker Hub (docker.io)
2. Environment variables
Ensure you have all of the required Environment variables for your application. Environment variables feed your application information from outside of the running of the application. They typically set things like database connection details and API keys.3. Build path
An incorrect build path can cause the application deployment to fail. This is the path in the repository to the files required to build the application. Most applications are built from the repository root, and the Build path defaults to this (.). If you have a different build path, you must specify this within Settings (Settings > Build > in the Environment section, click Change environment). For example, if your application needs to be built from a subdirectory (e.g. app), enter that subdirectory path in the Build path field: app.4. Start command or ENTRYPOINT
The Start command for the web process starts your application. If this is incorrect, the application will not run. You can specify the Start command within Processes > Web process > Update process. If your application uses a Dockerfile to set up your container image, you must specify theENTRYPOINT
in the Dockerfile to run a container. For more information about how to specify your application’s ENTRYPOINT
, see the Dockerfile reference.