Deploy

"Deploy to Zenifra" button

Maintain an open source project? Add a button to your README so anyone can publish your application on Zenifra in a few clicks. The button is a link to the Console that opens project creation already filled in with the source, port and environment variables you chose.

Deploy to Zenifra

What happens for the person who clicks

  1. The link opens the Console with the New project form filled in.
  2. Someone without an account signs up (or signs in) and comes straight back to the form, keeping everything from the link.
  3. They review the name, plan and variables, fill in missing values (such as secret keys) and create the project in their own organization.

Opening the link creates nothing: creation always goes through the confirmation of the person who clicked. The application stays on all the time, with no wait to "wake up" on the first request.

Once created, a project from a public repository is updated with a manual deploy in the Console. Automatic deploys on every push and pull request previews require connecting GitHub or GitLab.

Button or Template?

  • Deploy to Zenifra button: a link to your public repository or your image. There is no Template to create and no image to publish: the code comes straight from the repository.
  • Templates: ready-made applications from the Console catalog, such as n8n, Metabase and WordPress, with the image, plan and variables suggested by the author.

Repository: the Dockerfile is not used

With repository, Zenifra builds the image from the runtime you choose (runtime, version and the commands), and the repository Dockerfile is ignored. You do not need to publish an image to use the button. If the project already publishes an image, use image instead of repository.

The base address is https://console.zenifra.com/deploy. Choose one source:

  • image: a public image, such as ghcr.io/organization/application:latest;
  • repository: the HTTPS address of a public repository, such as https://github.com/organization/application. It works with GitHub, GitLab and other Git servers reachable over HTTPS, without the person connecting their account.

Then add the parameters you need:

ParameterSourceWhat it fills in
portbothPort the application listens on, from 1 to 65535.
envbothEnvironment variable. Repeat the parameter for each one: env=NAME=value, or just env=NAME for the person to fill in (use this for secrets).
namebothSuggested project name (lowercase letters, numbers and hyphens). The Console adds a short suffix, such as -a1b2c3d4, so the name does not clash between people who click. Without name, it uses the repository or image name.
planbothSuggested plan: free (legacy, only for organizations that already received the free plans), static, basic, premium, premium_plus, business, deep_learning_basic or deep_learning_premium. It applies only if the organization of the person who clicks can use that plan; otherwise the first available plan is kept.
payment_modebothBilling: hourly, monthly or yearly.
branchrepositoryPublished branch. Default: main.
rootrepositoryRoot directory of the application inside the repository (monorepos), such as apps/api.
runtimerepositoryRuntime: nodejs, python, bun, go, java or php.
versionrepositoryRuntime version, such as 24 or 3.12.
startrepositoryStart command.
buildrepositoryBuild command.
prebuildrepositoryCommand run before the build.

Encode values in the URL when they have special characters: = becomes %3D, a space becomes %20 and & becomes %26.

Examples

The minimal link has only the source and the port; the person chooses the rest in the Console:

https://console.zenifra.com/deploy?repository=https://github.com/organization/application&port=3000

The complete link fills in every field that is not a secret:

https://console.zenifra.com/deploy?repository=https://github.com/organization/application&branch=main&root=.&runtime=nodejs&version=24&prebuild=npm%20ci&build=npm%20run%20build&start=npm%20start&port=3000&name=my-app&plan=basic&payment_mode=hourly&env=NODE_ENV%3Dproduction&env=API_KEY

In it, env=NODE_ENV%3Dproduction is a fixed value and env=API_KEY arrives blank for the person to fill in. Secrets never go in the URL: the link is public in the README.

Public Node.js repository, with the runtime version and the start command:

https://console.zenifra.com/deploy?repository=https://github.com/organization/application&runtime=nodejs&version=24&start=npm%20start&port=3000

Public Python repository, with the start command and two variables:

https://console.zenifra.com/deploy?repository=https://github.com/organization/application&branch=main&runtime=python&version=3.12&start=my-api&port=8000&env=HOST%3D0.0.0.0&env=LOG_LEVEL%3DINFO

Public Docker image, with a variable the person fills in:

https://console.zenifra.com/deploy?image=ghcr.io/organization/application:latest&port=3000&env=API_KEY

Add the button to your README

Use the English or Portuguese badge and replace the link with yours:

[![Deploy to Zenifra](https://docs.zenifra.com/badge/deploy-en.svg)](https://console.zenifra.com/deploy?repository=https://github.com/organization/application&port=8000)
[![Deploy na Zenifra](https://docs.zenifra.com/badge/deploy-pt.svg)](https://console.zenifra.com/deploy?repository=https://github.com/organization/application&port=8000)

In HTML:

<a href="https://console.zenifra.com/deploy?repository=https://github.com/organization/application&port=8000">
  <img src="https://docs.zenifra.com/badge/deploy-en.svg" alt="Deploy to Zenifra" height="32">
</a>

Limits

  • The repository must be public. For private repositories, the person connects GitHub or GitLab and creates the project through the usual flow.
  • A project created from a public repository is updated with a manual deploy in the Console. Automatic publishing on every push and pull request previews require the Git provider connection.
  • The build uses the chosen runtime to create the application image; a Dockerfile in the repository is not used (see the notice in Button or Template?). If the project already publishes an image, prefer the image parameter.
  • The link creates one application. Databases, caches and other services the project needs are created separately in the Console.

Last updated on

On this page