> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Hospede uma aplicação ou bot em Ruby

> Hospede aplicações e bots em Ruby: inclua um Gemfile, defina o MAIN com o arquivo de entrada e a Square Cloud roda bundle install e inicia com ruby MAIN.

O runtime Ruby roda bots, workers, APIs e sites em Rails. A Square Cloud instala as suas gems com o Bundler e inicia a sua aplicação com o Ruby.

## Antes de começar

* Ruby na sua máquina. Se ainda não o tiver, baixe-o no [site oficial do Ruby](https://www.ruby-lang.org/pt/), ou use gerenciadores de versão como o [rbenv](https://github.com/rbenv/rbenv) ou o [rvm](https://rvm.io/).
* Uma conta na Square Cloud: [cadastre-se](https://squarecloud.app/pt-br/signup) com seu e-mail ou GitHub.
* Um plano ativo. Veja os [planos](https://squarecloud.app/pt-br/pricing) e escolha o que combina com o seu projeto.

## Configure a Square Cloud

<Note>
  Se você envia sua aplicação pelo dashboard, pode pular esta seção: o dashboard cria o arquivo de configuração `squarecloud.app` para você.
</Note>

<Card title="Referência do arquivo de configuração" icon="link" href="/pt-br/getting-started/config-file">
  O arquivo `squarecloud.app` diz à Square Cloud como executar a sua aplicação: o arquivo principal, a memória, a versão do runtime, o nome e, para um site, o subdomínio.
</Card>

Um arquivo de configuração completo para cada tipo de aplicação:

<Tabs>
  <Tab title="Bot ou worker">
    ```systemd squarecloud.app theme={"system"}
    MAIN=main.rb
    MEMORY=256
    VERSION=recommended
    DISPLAY_NAME=My bot
    START=bundle exec ruby main.rb
    ```
  </Tab>

  <Tab title="Site ou API">
    ```systemd squarecloud.app theme={"system"}
    MAIN=app.rb
    MEMORY=512
    VERSION=recommended
    DISPLAY_NAME=My website
    SUBDOMAIN=mywebsite
    START=bundle exec ruby app.rb
    ```
  </Tab>
</Tabs>

## O que a Square Cloud executa

* Se o campo `START` não estiver definido no arquivo de configuração, a Square Cloud executará `ruby MAIN`, onde o arquivo especificado em `MAIN` é o arquivo Ruby (ex.: `main.rb`). Se o campo `START` estiver definido, o valor nele será executado diretamente. É comum definir o `START` como `bundle exec ruby main.rb` ou outro comando de inicialização adequado. Para mais informações sobre os parâmetros do arquivo de configuração, visite [parâmetros de configuração](/pt-br/getting-started/config-file#parâmetros-de-configuração).

* Antes de iniciar a aplicação, a Square Cloud executa `bundle install` para instalar as gems listadas no seu `Gemfile`.

* O runtime define `RACK_ENV=production`, então aplicações Rack como Rails e Sinatra iniciam em modo de produção.

<Info>O Bundler lê as configurações dele de variáveis de ambiente, que são carregadas antes de o `bundle install` rodar. Para excluir grupos de gems desnecessários em produção, configure a variável `BUNDLE_WITHOUT=development:test`.</Info>

### Porta e host para sites e APIs

A Square Cloud define a variável de ambiente `PORT` como `80` e `HOST` como `0.0.0.0`. O seu servidor precisa escutar nessa porta e em todas as interfaces de rede. O Rails faz isso sem mudanças em produção; com Puma ou Sinatra, leia `ENV.fetch("PORT", 80)` e faça o bind em `0.0.0.0`.

## Prepare o projeto

### Arquivos necessários

* [`squarecloud.app`](/pt-br/getting-started/config-file), na raiz do ZIP.
* `main.rb`, ou o arquivo definido em `MAIN`: o ponto de entrada em Ruby.
* `Gemfile`, obrigatório: um upload sem ele falha com `INVALID_DEPENDENCY`.
* `Gemfile.lock`, gerado pelo Bundler: inclua-o para que o servidor instale as mesmas versões das gems.

<Warning>O arquivo de configuração (`squarecloud.app`) deve estar localizado na raiz do arquivo zip. Caso contrário, a Square Cloud não conseguirá encontrá-lo durante o deploy.</Warning>

### O que deixar de fora

* `vendor/bundle` e `.bundle`: gems instaladas para a sua máquina. A Square Cloud executa `bundle install` no servidor.
* `log/` e `tmp/`, quando a sua aplicação os cria.

## Guias de frameworks

<CardGroup cols={3}>
  <Card title="Ruby on Rails" icon="gem" href="/pt-br/tutorials/website/ruby-on-rails" />
</CardGroup>

## Faça o deploy

### Via dashboard

<Steps>
  <Step title="Acesse a página de upload">
    Acesse a [página de upload](https://squarecloud.app/pt-br/dashboard/new) e envie seu arquivo zip.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Faça o deploy do projeto">
    Por fim, clique no botão "Deploy" para hospedar seu projeto na Square Cloud.
    Após o deploy, você poderá monitorar o status e os registros do seu projeto no dashboard.

    <Frame>
      <img src="https://cdn.squarecloud.app/docs/articles/dashboard/uploading-pt-br.gif" alt="Enviando aplicação para a Square Cloud" style={{ borderRadius: "0.2rem" }} />
    </Frame>
  </Step>

  <Step title="Confirme que seu app está no ar">
    Seu primeiro deploy geralmente leva menos de um minuto. No [dashboard](https://squarecloud.app/pt-br/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 `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.
    <Tip>Seu app não está iniciando? Veja o [guia de solução de problemas](/pt-br/platform/troubleshooting/app-wont-start) para as causas e correções mais comuns.</Tip>
  </Step>
</Steps>

### Via CLI

Para usar esse método, seu projeto precisa de um arquivo de configuração chamado `squarecloud.app` na raiz. Ele informa à Square Cloud como executar a sua aplicação.

<Card title="Guia do arquivo de configuração" icon="link" href="/pt-br/getting-started/config-file">
  Saiba como criar o arquivo de configuração `squarecloud.app` que define o ambiente da sua aplicação.
</Card>

<Steps>
  <Step title="Instale a CLI">
    Instale a [CLI da Square Cloud](/pt-br/cli-reference/installation). Se você já a tem, execute o mesmo comando para atualizá-la:

    <CodeGroup>
      ```bash macOS, Linux e WSL theme={"system"}
      curl -fsSL https://cli.squarecloud.app/install | bash
      ```

      ```bash Windows com npm theme={"system"}
      npm install -g @squarecloud/cli@latest
      ```
    </CodeGroup>
  </Step>

  <Step title="Faça login">
    Execute o comando abaixo. Ele abre o seu navegador: aprove o login lá e a CLI está pronta. Não há nenhuma chave de API para copiar. Para scripts e CI, veja [autenticação da CLI](/pt-br/cli-reference/authentication).

    ```bash theme={"system"}
    squarecloud auth login
    ```
  </Step>

  <Step title="Envie o seu projeto">
    Na pasta do seu projeto, execute o comando abaixo. A CLI compacta a pasta atual, deixando de fora o que o [`squarecloud.ignore`](/pt-br/getting-started/squarecloud-ignore) lista, e faz o upload:

    ```bash theme={"system"}
    squarecloud upload
    ```

    Para enviar um zip que você mesmo criou, passe-o com `--file`:

    ```bash theme={"system"}
    squarecloud upload --file <caminho/para/zip>
    ```
  </Step>

  <Step title="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:

    ```bash theme={"system"}
    squarecloud app status
    squarecloud app logs
    ```

    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.
    <Tip>Seu app não está iniciando? Veja o [guia de solução de problemas](/pt-br/platform/troubleshooting/app-wont-start) para as causas e correções mais comuns.</Tip>
  </Step>
</Steps>

## Próximos passos

<CardGroup cols={3}>
  <Card title="Variáveis de ambiente" icon="key" href="/pt-br/platform/environment-variables">
    Mantenha segredos e configurações fora do código e leia-os em tempo de execução.
  </Card>

  <Card title="Domínio personalizado" icon="globe" href="https://help.squarecloud.app/pt-br/article/como-configurar-seu-proprio-dominio-cnamedns-j39hh2/">
    Sirva a sua aplicação no seu próprio domínio, a partir do plano Standard.
  </Card>

  <Card title="Solução de problemas" icon="wrench" href="/pt-br/platform/troubleshooting">
    Corrija uma aplicação que não inicia ou um site que não responde.
  </Card>
</CardGroup>

## Contate-nos

Se você continuar enfrentando **dificuldades técnicas**, nossa **equipe de suporte especializada** está disponível para auxiliá-lo. [**Entre em contato conosco**](https://squarecloud.app/pt-br/support) e teremos prazer em ajudá-lo a resolver qualquer questão: a qualidade do suporte é uma grande parte do motivo pelo qual desenvolvedores avaliam a Square Cloud com [**4,9/5 em 402 avaliações**](https://www.trustpilot.com/review/squarecloud.app) no Google e Trustpilot.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.