> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# O que é o Ayakaleaf Toolkit?

O Ayakaleaf Toolkit é o método de implantação recomendado para instalações on-premises do Community Edition e do Ayakaleaf Pro. Ele foi projetado para funcionar no ambiente mais comum: um único servidor físico ou máquina virtual. O Toolkit usa `docker compose` para gerenciar os contêineres Docker do seu servidor e fornece um conjunto de scripts que encapsulam comandos `docker` para ajudar com a parte mais técnica do gerenciamento de uma versão on-premises do Overleaf.

#### O wrapper `bin/docker-compose`

O script `bin/docker-compose` é um wrapper em torno do `docker compose`. Ele carrega a configuração do diretório `config/` antes de invocar o `docker compose` com os argumentos que foram passados ao script.

Você pode tratar o `bin/docker-compose` como um wrapper transparente para o programa `docker compose` instalado na sua máquina.

Exemplo:

```bash title="Check running containers" theme={null}
$ bin/docker-compose ps
```

#### Scripts auxiliares

Além do `bin/docker-compose`, o Toolkit fornece scripts práticos para ajudar em tarefas comuns:

* `bin/up`: atalho para `bin/docker-compose up`
* `bin/start`: atalho para `bin/docker-compose start`
* `bin/stop`: atalho para `bin/docker-compose stop`
* `bin/shell`: inicia um shell dentro do contêiner **sharelatex**
* `bin/doctor`: script usado para coletar informações sobre a instalação e a implantação. Consulte a seção "Verificando seu servidor" abaixo
* `bin/mongo`: inicia um shell dentro do contêiner **mongo** e muda para o banco de dados correto (**sharelatex**)
* `bin/backup-config`: cria uma cópia (zip ou tar) da sua configuração atual e a armazena em um diretório de destino de sua escolha
* `bin/logs`: visualiza/acompanha os logs dos serviços
* `bin/error-logs`: visualiza/acompanha os logs de erro dos serviços
* `bin/rename-env-vars-5-0`: script de migração para atualizar variáveis de ambiente em **config/variables.env** (mudança de marca de ShareLaTeX para Overleaf)
* `bin/rename-rc-vars`: script de migração para atualizar variáveis de ambiente em **config/overleaf.rc** (mudança de marca de ShareLaTeX para Overleaf)
* `bin/run-script`: auxiliar para simplificar a execução de scripts armazenados no contêiner **sharelatex**
* `bin/upgrade`: auxilia nas atualizações da instância. O script verifica se há atualizações do Toolkit (via git) e oferece a opção de baixar as alterações, verifica a versão mais recente da imagem Docker e oferece a opção de atualizá-la. Ele fornece confirmação passo a passo, a opção de fazer backup da configuração atual e cuida de parar/iniciar os serviços Docker. Consulte Atualizando sua implantação para mais informações: [https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment](https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment)

<Info>
  Se preferir executar sua instância sem se conectar aos logs do Docker, você pode executar `bin/up -d` para rodar em modo destacado (detached).
</Info>

#### Verificando seu servidor

O Overleaf Toolkit inclui um script prático chamado `bin/doctor`, que gera um relatório indicando qualquer dependência não atendida.

Antes de continuar, execute o script `bin/doctor` e verifique se tudo está funcionando corretamente:

```bash title="Run Overleaf Doctor" theme={null}
bin/doctor
```

Exemplo de saída (truncada/ilustrativa):

<Accordion title="Exemplo de saída do bin/doctor">
  ```text theme={null}
  ====== Overleaf Doctor ======
  - Host Information
      - Linux
      - Output of 'lsb_release -a':
              No LSB modules are available.
              Distributor ID:     Ubuntu
              Description:        Ubuntu 22.04.5 LTS
              Release:    22.04
              Codename:   jammy
  - Dependencies
      - bash
          - status: present
          - version info: 5.1.16(1)-release
      - docker
          - status: present
          - version info: Docker version 27.3.1, build ce12230
      - realpath
          - status: present
          - version info: realpath (GNU coreutils) 8.32
      - perl
          - status: present
          - version info: 5.034000
      - awk
          - status: present
          - version info: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
      - openssl
          - status: present
          - version info: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
      - docker compose
          - status: present
          - version info: Docker Compose version v2.29.7
  - Docker Daemon
      - status: up
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.1.1
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: data/overleaf
          - OVERLEAF_LOG_PATH: data/overleaf/logs
          - SERVER_PRO: true
              - logged in to quay.io: true
          - SIBLING_CONTAINERS_ENABLED: true
          - OVERLEAF_LISTEN_IP: 0.0.0.0
          - OVERLEAF_PORT: 80
          - MONGO_ENABLED: true
          - MONGO_IMAGE: mongo
          - MONGO_VERSION: 6.0
          - MONGO_DATA_PATH: data/mongo
          - REDIS_ENABLED: true
          - REDIS_IMAGE: redis:6.2
          - REDIS_DATA_PATH: data/redis
  - config/variables.env
      - status: present
      - values
          - OVERLEAF_FILESTORE_BACKEND: fs
          - OVERLEAF_HISTORY_BACKEND: fs
  ====== Warnings ======
  - None, all good
  ====== End ======
  ```
</Accordion>

Se alguma dependência estiver faltando, o doctor exibirá avisos. Se você tiver problemas, primeiro execute `bin/doctor` e verifique se há avisos na saída.

<Info>
  * Os usuários da edição Ayakaleaf Pro podem abrir uma issue no GitHub: [https://github.com/ayaka-notes/toolkit/issues](https://github.com/ayaka-notes/toolkit/issues)

  Em ambos os casos, inclua a saída do `bin/doctor` na sua mensagem.
</Info>


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