Deploy

Botão "Deploy na Zenifra"

Mantém um projeto open source? Coloque um botão no README para que qualquer pessoa publique a sua aplicação na Zenifra em poucos cliques. O botão é um link para o Console que abre a criação de projeto já preenchida com a origem, a porta e as variáveis de ambiente que você escolheu.

Deploy na Zenifra

Como funciona para quem clica

  1. O link abre o Console com o formulário de Novo projeto preenchido.
  2. Quem ainda não tem conta faz o cadastro (ou o login) e volta direto para o formulário, sem perder o que estava no link.
  3. A pessoa revisa o nome, o plano e as variáveis, completa os valores que faltam (como chaves secretas) e cria o projeto na própria organização.

Nada é criado só por abrir o link: a criação sempre passa pela confirmação de quem clicou. A aplicação fica ligada o tempo todo, sem espera para "acordar" no primeiro acesso.

Depois de criado, um projeto de repositório público recebe atualizações por deploy manual no Console. Deploy automático a cada push e previews de pull request exigem conectar o GitHub ou o GitLab.

Botão ou Template?

  • Botão Deploy na Zenifra: um link para o seu repositório público ou para a sua imagem. Não precisa criar Template nem publicar imagem: o código sai direto do repositório.
  • Templates: aplicações prontas do catálogo do Console, como n8n, Metabase e WordPress, com imagem, plano e variáveis sugeridos pelo autor.

Repositório: o Dockerfile não é usado

Com repository, a Zenifra gera a imagem a partir do runtime que você escolher (runtime, version e os comandos), e o Dockerfile do repositório é ignorado. Não é preciso publicar uma imagem para usar o botão. Se o projeto já publica uma imagem, use image no lugar de repository.

O endereço base é https://console.zenifra.com/deploy. Escolha uma origem:

  • image: uma imagem pública, como ghcr.io/organizacao/aplicacao:latest;
  • repository: o endereço HTTPS de um repositório público, como https://github.com/organizacao/aplicacao. Funciona com GitHub, GitLab e outros servidores Git acessíveis por HTTPS, sem que a pessoa precise conectar a conta dela.

Depois, acrescente os parâmetros que quiser:

ParâmetroOrigemO que preenche
portambasPorta em que a aplicação escuta, de 1 a 65535.
envambasVariável de ambiente. Repita o parâmetro para cada uma: env=NOME=valor, ou só env=NOME para a pessoa preencher (use isso para segredos).
nameambasNome sugerido do projeto (letras minúsculas, números e hífens). O Console acrescenta um sufixo curto, como -a1b2c3d4, para o nome não repetir entre quem clica. Sem name, usa o nome do repositório ou da imagem.
planambasPlano sugerido: free (legado, só para organizações que já receberam os planos gratuitos), static, basic, premium, premium_plus, business, deep_learning_basic ou deep_learning_premium. Vale só se a organização de quem clica puder usar esse plano; senão, fica o primeiro plano disponível.
payment_modeambasForma de cobrança: hourly (por hora), monthly (mensal) ou yearly (anual).
branchrepositoryBranch publicada. Padrão: main.
rootrepositoryDiretório raiz da aplicação dentro do repositório (monorepos), como apps/api.
runtimerepositoryRuntime: nodejs, python, bun, go, java ou php.
versionrepositoryVersão do runtime, como 24 ou 3.12.
startrepositoryComando de inicialização.
buildrepositoryComando de build.
prebuildrepositoryComando executado antes do build.

Codifique os valores na URL quando tiverem caracteres especiais: = vira %3D, espaço vira %20 e & vira %26.

Exemplos

O link mínimo tem só a origem e a porta; o restante a pessoa escolhe no Console:

https://console.zenifra.com/deploy?repository=https://github.com/organizacao/aplicacao&port=3000

O link completo preenche todos os campos que não são segredo:

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

Nele, env=NODE_ENV%3Dproduction é um valor fixo e env=API_KEY chega em branco para a pessoa preencher. Segredos nunca vão na URL: o link fica público no README.

Repositório público em Node.js, com a versão do runtime e o comando de inicialização:

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

Repositório público em Python, com o comando de inicialização e duas variáveis:

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

Imagem Docker pública, com uma variável que a pessoa preenche:

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

Adicionar o botão ao README

Use o badge em português ou em inglês e troque o link pelo seu:

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

Em HTML:

<a href="https://console.zenifra.com/deploy?repository=https://github.com/organizacao/aplicacao&port=8000">
  <img src="https://docs.zenifra.com/badge/deploy-pt.svg" alt="Deploy na Zenifra" height="32">
</a>

Limites

  • O repositório precisa ser público. Para repositórios privados, a pessoa conecta o GitHub ou o GitLab e cria o projeto pelo fluxo normal.
  • Um projeto criado a partir de um repositório público é atualizado por deploy manual no Console. Publicação automática a cada push e previews de pull request exigem a conexão com o provedor Git.
  • O build usa o runtime escolhido para gerar a imagem da aplicação; um Dockerfile do repositório não é usado (veja o aviso em Botão ou Template?). Se o projeto já publica uma imagem, prefira o parâmetro image.
  • O link cria uma aplicação. Banco de dados, cache e outros serviços que o projeto precise são criados à parte no Console.

Última atualização em

Nessa página