> ## 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.

# 2. Familiarize-se com o Toolkit

### Dando uma olhada

Agora que você tem uma cópia local do Toolkit, vamos analisar a estrutura do repositório usando o comando `ls`.

```bash title="Run this" theme={null}
ls -l
```

> [!NOTE]
>
> O comando `ls -l` exibe uma listagem detalhada do conteúdo de um diretório, fornecendo informações adicionais sobre os arquivos, como permissões, proprietário e tamanho.

Se tudo tiver sido clonado com sucesso, você deverá ver algo assim:

```text theme={null}
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md
```

> [!NOTE]
>
> Todos os arquivos de configuração do usuário encontram-se no diretório `config/`. Este diretório é **excluído** do sistema de controle de versão git, portanto não será alterado ao atualizar o Toolkit.

## Estrutura do repositório

| Nome | Descrição |
| - | - |
| `bin` | Esta pasta contém um conjunto de scripts que ajudam a gerenciar a sua instância do servidor Overleaf. Você pode ler mais sobre esses scripts na seção Comandos abaixo. |
| `config` | Esta pasta contém os seus próprios arquivos de configuração locais. |
| `lib` | Esta pasta contém os arquivos de configuração base usados pelo Toolkit. |
| `data` | Por padrão, esta pasta contém o local de armazenamento do MongoDb, do Redis e do Overleaf. Para mais informações, consulte a seção [Dados persistentes](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/files-and-locations.md#persistent-data) abaixo. |

> [!WARNING]
>
> Recomendamos **não** alterar diretamente arquivos fora da pasta `/config`. Em vez disso, se precisar fazer alterações, elas podem ser feitas através de variáveis de ambiente definidas em **config/variables.env** ou **config/overleaf.rc**.\
> Por exemplo, para definir a imagem do serviço `mongo`, em vez de editar `lib/docker-compose.mongo.yml` diretamente, defina a imagem usando a variável de ambiente `MONGO_IMAGE` em `config/overleaf.rc`. Para mais informações, consulte a página [Configurações do Toolkit](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/toolkit-settings.md).

> [!NOTE]
>
> O Toolkit **não** alterará nenhum dado no diretório `config/` sem a sua permissão.

## Comandos

Execute estes scripts a partir do diretório do Toolkit. Cada um exibe suas opções com `--help`.

| Comando | O que faz |
| - | - |
| `bin/init` | Cria os arquivos de configuração em `config/` na primeira vez. `bin/init --tls` adiciona a configuração do proxy TLS do NGINX. |
| `bin/up` | Cria e inicia os contêineres (`bin/docker-compose up`). Adicione `-d` para executar em segundo plano em vez de acompanhar os logs. Execute-o após cada alteração em `config/`: ele recria os contêineres cuja configuração mudou. |
| `bin/start` | Inicia novamente os contêineres existentes (`bin/docker-compose start`). Não aplica alterações de configuração. |
| `bin/stop` | Para os contêineres e os mantém (`bin/docker-compose stop`). |
| `bin/docker-compose` | Executa `docker compose` com os arquivos do Toolkit, por exemplo `bin/docker-compose ps` ou `bin/docker-compose restart sharelatex`. |
| `bin/logs` | Mostra ou acompanha os logs de um ou mais serviços, por exemplo `bin/logs -f web`. |
| `bin/error-logs` | Como `bin/logs`, mas mostra apenas os erros. |
| `bin/shell` | Abre um shell dentro do contêiner `sharelatex`. |
| `bin/mongo` | Abre um shell do MongoDB no banco de dados `sharelatex`. |
| `bin/run-script` | Executa um script incluído no contêiner `sharelatex`. |
| `bin/doctor` | Verifica o host e a configuração e exibe um relatório para compartilhar quando você pedir ajuda. |
| `bin/images` | Lista as imagens Docker do Overleaf no host. |
| `bin/backup-config` | Copia o diretório `config/` para um local de backup (cópia, zip ou tar). |
| `bin/upgrade` | Atualiza o Toolkit e a imagem do Overleaf passo a passo; consulte [Atualizando sua implantação](https://ayakaleaf-pro.mintlify.site/pt/on-premises/maintenance/upgrading-your-deployment.md). |
| `bin/rename-env-vars-5-0`, `bin/rename-rc-vars` | Migrações pontuais de nomes de variáveis antigos `SHARELATEX_*` para `OVERLEAF_*`. |

> [!WARNING]
>
> Quando o `bin/up` recria um contêiner, tudo o que foi alterado dentro dele é perdido, por exemplo pacotes instalados ou arquivos editados por meio do `bin/shell`. Apenas os diretórios de dados (`data/` por padrão) e `config/` são mantidos. Faça alterações permanentes por meio de `config/variables.env`, `config/overleaf.rc` ou `config/docker-compose.override.yml`.

> [!NOTE]
>
> Se cada `bin/up` desconectar todos os usuários, defina `OVERLEAF_SESSION_SECRET`. Sem ela, os cookies de sessão são assinados com um segredo que é gerado novamente sempre que o contêiner é recriado; consulte as Q\&A em [Variáveis de ambiente](https://ayakaleaf-pro.mintlify.site/pt/on-premises/configuration/overleaf-toolkit/environment-variables.md).


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