Documentation / Get started
Deploy your first service
From a GitHub repository to a working HTTPS address.
Before you start
You need an approved GitHub account and a repository the Upferry GitHub App can access. Open the panel, sign in, and allow access to the required repository. If GitHub sends you back to the sign-in page, check that your account is approved and the App installation includes that repository.
Create a project and service
- Create a project and choose a name.
- Add a service from a GitHub repository. Select the repository and branch.
- For a monorepo, set the service's root directory to the application folder.
- Check the detected build and start commands. A Dockerfile in the service source can define the container instead.
- Add the required environment variables, then deploy. If creation already started a build, missing variables may require a new deployment.
Your HTTP process must listen on 0.0.0.0 and the configured service port. Read the provided PORT variable in application code. Listening only on localhost prevents the proxy from reaching it.
Check the result
Open the deployment to watch build logs, then runtime logs. For an HTTP service, configure a generated domain in its networking settings and open the displayed HTTPS address. Configure a health check such as /health; it must return HTTP 2xx when the application is ready.
For example, check your own address:
curl -fsS https://YOUR-SERVICE.up.upferry.com/health
The address is shown in the panel; replace the placeholder. A successful build alone does not prove that your page, database connection, login, or background work functions correctly. Exercise those application paths too.
Add persistence and a custom domain
The container's writable filesystem is temporary. Use a volume or database for persistent data. Once the generated address works, connect . Enable and try a restore before relying on the data.