> ## 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 um site ou API em PHP

> Hospede um site ou API em PHP na Square Cloud: defina o MAIN como index.php, deixe a Square Cloud rodar o Composer e sirva com o servidor do PHP ou Swoole.

O runtime PHP serve sites e APIs em PHP. Ele inclui o Composer, o Node.js para o build de assets e a extensão Swoole.

## Antes de começar

* PHP na sua máquina. Se ainda não o tiver, baixe-o no [site oficial do PHP](https://www.php.net/).
* 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 um site ou API:

```systemd squarecloud.app theme={"system"}
MAIN=index.php
MEMORY=512
VERSION=recommended
DISPLAY_NAME=My website
SUBDOMAIN=mywebsite
```

## O que a Square Cloud executa

* Se o campo `START` não estiver definido no arquivo de configuração, será iniciado um servidor PHP local com o comando `php -S 0.0.0.0:80`, com a raiz do seu ZIP como document root. Se o campo `START` estiver definido, o valor nele será executado diretamente. 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).

* Se o seu projeto tiver um `composer.json` na raiz, a Square Cloud roda `composer install` antes de cada inicialização, então você não precisa colocá-lo no `START`. Ela usa o `composer.phar` do seu ZIP quando houver um e, caso contrário, o Composer incluído no runtime. Envie também o `composer.lock`, para que o servidor instale as mesmas versões que você testou.

### Porta e host

O comando padrão já escuta na porta 80 e em todas as interfaces de rede (`0.0.0.0`). Quando você escrever o seu próprio `START`, mantenha as duas coisas: a Square Cloud define a variável de ambiente `PORT` como `80`, e um servidor que escuta apenas em `127.0.0.1` nunca recebe requisições.

## PHP com Swoole

* Swoole é uma ferramenta que melhora o desempenho padrão do PHP, permitindo que o servidor web atenda múltiplas requisições de forma assíncrona.

* Com esta ferramenta, você consegue criar microsserviços, websockets, filas em segundo plano, entre outros. Ele também permite executar eventos assim como o JavaScript.

* Vale mencionar também que o Swoole é compatível com outros frameworks PHP. Um bom exemplo é o Laravel, que é compatível com o Swoole graças ao Octane.

* Você pode usá-lo no lugar do servidor PHP padrão, definindo o seu comando START personalizado. Exemplo:

```bash theme={"system"}
npm install && npm run build && php artisan optimize && php artisan octane:start --host=0.0.0.0 --port=80 --workers=4 --task-workers=8 --server=swoole
```

* Você pode conferir todas as funções do Swoole no [manual do Swoole](https://www.php.net/manual/pt_BR/book.swoole.php).

## Prepare o projeto

### Arquivos necessários

* [`squarecloud.app`](/pt-br/getting-started/config-file), na raiz do ZIP.
* `index.php`, ou o arquivo definido em `MAIN`.
* `composer.json` e `composer.lock`, quando você usa pacotes do Composer.

A Square Cloud instala sozinha os pacotes listados no `composer.json`. Se o seu projeto também tiver dependências do Node (um `package.json`) para o build dos assets, instale e faça o build delas no `START`. Por exemplo:

```systemd squarecloud.app theme={"system"}
START=npm install && npm run build && php -S 0.0.0.0:80
```

<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

* O seu arquivo `.env` local: defina os seus segredos como [variáveis de ambiente](/pt-br/platform/environment-variables). O servidor padrão usa a raiz do ZIP como document root, então qualquer arquivo que você enviar ali pode ser baixado.
* `vendor/`: a Square Cloud a instala a partir do `composer.json`.
* `node_modules/`, quando o seu comando `START` a instala.

## Guias de frameworks

<CardGroup cols={3}>
  <Card title="Laravel" icon="laravel" href="/pt-br/tutorials/api/laravel" />
</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.