🚀 Introdução
- Antes de começar, certifique‑se de que o Ruby está instalado no seu sistema. Se ainda não o tiver, você pode baixá‑lo no site oficial do Ruby, ou usar gerenciadores de versões como rbenv ou rvm.
- Em seguida, será necessário criar uma conta na Square Cloud, o que pode ser feito através da página de login. Você pode usar seu e‑mail, GitHub ou ambos para criar a conta.
- Por fim, é necessário ter um plano pago ativo na sua conta. Você pode ver nossos planos e adquirir um conforme sua necessidade aqui.
⚙️ Configuração do arquivo squarecloud.app
Se você estiver enviando sua aplicação através do website da Square Cloud, você pode ignorar esta seção. O site cria automaticamente o arquivo de configuração
squarecloud.app para você.Saiba mais: como criar o arquivo de configuração para a Square Cloud.
O arquivo squarecloud.app é um arquivo de configuração que será usado para
configurar sua aplicação; ele servirá para definir nome, descrição,
versão, arquivo principal, entre outras coisas.
📄 Arquivos Obrigatórios
- main.rb (Exemplo de arquivo principal — seu ponto de entrada Ruby).
- Gemfile (Arquivo de dependências, caso use Bundler).
- Gemfile.lock (Gerado pelo Bundler; recomendado incluir para builds reprodutíveis).
- squarecloud.app (arquivo que contém a configuração da Square Cloud).
▶️ Como iniciar sua aplicação
- Se o campo
STARTnão estiver definido no arquivo de configuração, a Square Cloud executaráruby MAIN, onde o arquivo especificado emMAINé o arquivo Ruby (por exemplomain.rb). Se o campoSTARTestiver definido, o valor nele será executado diretamente. Em aplicações que usam Bundler, é comum definirSTARTcomobundle exec ruby main.rbou outro comando de inicialização adequado. Para mais informações sobre os parâmetros do arquivo de configuração, visite configuration parameters.
Para aplicações Ruby que utilizam Bundler, é importante configurar adequadamente as variáveis de ambiente para otimizar o processo de instalação de dependências na Square Cloud. A Square Cloud executa a instalação do bundler usando variáveis de ambiente. Para excluir grupos de gems desnecessários em produção, configure a variável
BUNDLE_WITHOUT=development:test. Isso também ajuda a remover deprecations do Bundler 2.x.🖥️ Preparando o projeto
Antes de hospedar seu projeto na Square Cloud, verifique se os arquivos do projeto estão corretamente configurados para hospedagem.📤 Como hospedar seu projeto
Agora que você preparou todos os arquivos do seu projeto Ruby, o próximo passo é enviá-los para a Square Cloud e colocar sua aplicação no ar. Existem varias formas de fazer o upload, mas vamos abordar duas: via Dashboard ou via CLI.Via dashboard
1
Acesse a página de upload
Acesse a página de upload e envie seu arquivo zip.
2
Configure seu ambiente
Após fazer o upload do seu arquivo zip, você precisará configurar o nome, o arquivo principal ou o ambiente de execução e outras configurações do seu projeto.
Se você estiver enviando um projeto web, certifique-se de selecionar “Publicação na Web” e definir um subdomínio para o seu projeto.
Se você estiver enviando um projeto web, certifique-se de selecionar “Publicação na Web” e definir um subdomínio para o seu projeto.
3
Faça o deploy do projeto
Por fim, clique no botão “Deploy” para hospedar seu projeto no Square Cloud.
Após o deploy, você poderá monitorar o status e os registros do seu projeto no painel.

4
Confirme que seu app está no ar
Seu primeiro deploy geralmente leva menos de um minuto. No dashboard, aguarde o status da sua aplicação mudar para em execução e verifique os registros em busca de erros de inicialização.
Se você fez deploy de um site ou API, abra
Se você fez deploy de um site ou API, abra
https://<seu-subdominio>.squareweb.app no navegador — você deve ver sua aplicação respondendo. Se você fez deploy de um bot, envie um comando para confirmar que ele está online.
Via CLI
Para usar esse método, você precisa criar um arquivo de configuração chamadosquarecloud.app no diretório raiz do seu projeto. Esse arquivo conterá a configuração necessária para o seu projeto.
Guia do arquivo de configuração
Saiba como criar o arquivo de configuração
squarecloud.app que define o ambiente da sua aplicação.1
Primeiro Passo
Primeiro, você precisa ter a CLI instalada em seu ambiente. Se você ainda não a possui, execute o seguinte comando em seu terminal:Se você já a possui, recomendamos atualizá-la. Para fazer isso, execute o seguinte comando em seu terminal:
- Windows
- Linux, macOS, e WSL
2
Segundo Passo
Agora, para autenticar e usar outros comandos da CLI, você encontrará sua chave de autorização aqui clicando em “Solicitar Chave da API”. Após obter sua chave de autorização, execute o seguinte comando:
3
Terceiro Passo
Finalmente, para fazer o deploy da sua aplicação para a Square Cloud usando a CLI, você precisa executar o seguinte comando:Ou se já possui o zip criado:
4
Confirme que seu app está no ar
Seu primeiro deploy geralmente leva menos de um minuto. Verifique o status e os registros da sua aplicação diretamente pelo terminal:Se você fez deploy de um site ou API, abra
https://<seu-subdominio>.squareweb.app no navegador — você deve ver sua aplicação respondendo. Se você fez deploy de um bot, envie um comando para confirmar que ele está online.

