Documentação do Pronto

Tudo o que você precisa para instalar, configurar e executar o Pronto no seu próprio servidor.

Self-hostedDocker ComposeLicença MIT

Início rápido

1

Clonar o repositório

Clone o repositório público e copie o arquivo de ambiente:

git clone https://github.com/SGrappelli/pronto.git
cd pronto
cp .env.example .env
2

Configurar o ambiente

Abra o .env e preencha as variáveis obrigatórias. Mínimo necessário: NEXT_PUBLIC_SUPABASE_URL, NEXT_PUBLIC_SUPABASE_ANON_KEY, SUPABASE_SERVICE_ROLE_KEY. Consulte a referência completa de variáveis abaixo.

3

Iniciar a aplicação

Execute o seguinte comando. As migrações são executadas automaticamente na inicialização:

docker compose up -d

Sua instância estará disponível em http://localhost:3000

Requisitos do sistema

RequisitoMínimo
Sistema operacionalLinux, macOS ou Windows (WSL2)
RAM1 GB mínimo, 2 GB recomendado
Disco5 GB de espaço livre
DockerDocker 24+ com Docker Compose v2
InternetNecessário para configuração inicial e notificações
Domínio (opcional)Qualquer domínio ou subdomínio apontando para seu servidor

Variáveis de ambiente

Copie .env.example para .env e preencha os valores indicados.

VariávelObrigatóriaDescrição
NEXT_PUBLIC_SUPABASE_URL✅URL do seu projeto Supabase
NEXT_PUBLIC_SUPABASE_ANON_KEY✅Chave anônima do Supabase
SUPABASE_SERVICE_ROLE_KEY✅Chave de função de serviço (manter em segredo)
NEXTAUTH_SECRET✅String aleatória para criptografia de sessão
NEXTAUTH_URL✅URL completa da sua instância (ex. https://seudominio.com)
NEXT_PUBLIC_DEPLOYMENT_MODE✅Definir como: selfhosted
RESEND_API_KEY⚡Chave API do Resend para notificações por e-mail
TELEGRAM_BOT_TOKEN⚡Token do bot do Telegram do @BotFather
WHATSAPP_PHONE_NUMBER_ID⚡ID do número de telefone da Meta Cloud API
WHATSAPP_ACCESS_TOKEN⚡Token de acesso permanente da Meta Cloud API
VIBER_BOT_TOKEN⚡Token do bot do Viber

NEXT_PUBLIC_DEPLOYMENT_MODE=selfhosted remove toda a interface de cobrança SaaS e habilita clientes, funcionários e locais ilimitados.

Configuração de notificações

E-mail (Resend)+
  1. 1.Crie uma conta gratuita em resend.com
  2. 2.Adicione e verifique seu domínio
  3. 3.Gere uma chave API
  4. 4.Defina RESEND_API_KEY no seu arquivo .env
  5. 5.Reinicie: docker compose restart app
Telegram+
  1. 1.Abra o Telegram e escreva para @BotFather
  2. 2.Envie /newbot e siga as instruções
  3. 3.Copie o token recebido
  4. 4.Defina TELEGRAM_BOT_TOKEN no seu arquivo .env
  5. 5.No Pronto → Configurações → Notificações, insira o token do bot por negócio
WhatsApp (Meta Cloud API)+
  1. 1.Acesse developers.facebook.com e crie um aplicativo
  2. 2.Adicione o produto WhatsApp ao seu app
  3. 3.Copie seu Phone Number ID e gere um token de acesso permanente
  4. 4.Defina WHATSAPP_PHONE_NUMBER_ID e WHATSAPP_ACCESS_TOKEN no .env
  5. 5.Nota: mensagens de texto livre funcionam apenas dentro da janela de atendimento ao cliente de 24 horas. Mensagens iniciadas pelo negócio exigem templates HSM aprovados no Meta Business Manager.
Viber+
  1. 1.Acesse partners.viber.com e crie um bot
  2. 2.Copie o token do bot
  3. 3.Defina VIBER_BOT_TOKEN no seu arquivo .env
  4. 4.Nota: bots do Viber criados após fevereiro de 2024 exigem um plano comercial (~€100/mês).

Atualizar para uma nova versão

git pull origin main
docker compose down
docker compose up -d --build

As migrações são executadas automaticamente na inicialização — nenhuma etapa SQL manual é necessária.

Perguntas frequentes

Quais são os requisitos mínimos do servidor para executar o Pronto?+

O Pronto requer Docker 24+, 1 GB de RAM mínimo (2 GB recomendado) e 5 GB de espaço livre em disco. Funciona em Linux, macOS ou Windows com WSL2. Um VPS de $6/mês é suficiente para a maioria dos pequenos negócios.

Preciso de uma conta Supabase para hospedar o Pronto?+

Sim. O Pronto usa o Supabase para banco de dados e autenticação. Você pode usar o nível gratuito do Supabase, que suporta até 500 MB de armazenamento de banco de dados, mais que suficiente para a maioria das implantações de pequenos negócios.

Como ativo as notificações do WhatsApp?+

O Pronto usa a Meta Cloud API para WhatsApp. Você precisa de uma conta Meta Developer e um número WhatsApp Business verificado. Defina WHATSAPP_PHONE_NUMBER_ID e WHATSAPP_ACCESS_TOKEN no seu arquivo .env. Mensagens iniciadas pelo negócio exigem templates de mensagens aprovados previamente.

Posso executar o Pronto sem um nome de domínio?+

Sim. O Pronto funciona com um endereço IP simples ou localhost para uso local. Para produção com SSL, recomenda-se um nome de domínio. Você pode usar qualquer proxy reverso (Nginx, Caddy) para adicionar HTTPS.

Como atualizo o Pronto para uma nova versão?+

Execute git pull origin main, depois docker compose down && docker compose up -d --build. As migrações de banco de dados são executadas automaticamente na inicialização — nenhuma etapa SQL manual é necessária.

Há limite de clientes ou funcionários na versão self-hosted?+

Não. A versão self-hosted é completamente ilimitada — sem limites de clientes, funcionários, locais ou agendamentos. Defina NEXT_PUBLIC_DEPLOYMENT_MODE=selfhosted no seu .env para ativar este modo.

Onde posso obter ajuda se algo não funcionar?+

Abra uma issue no repositório do GitHub em github.com/SGrappelli/pronto. A comunidade e os mantenedores respondem às issues lá. Para assistência de instalação paga, entre em contato pela página do GitHub.

Prefere uma versão gerenciada?

Não quer gerenciar um servidor? O Pronto também está disponível como serviço em nuvem em trypronto.app — sem instalação.

Experimentar a versão em nuvem →Ver no GitHub →