> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/pt/primeiros-passos/what-is-the-overleaf-toolkit.md). # O que é o Ayakaleaf Toolkit? O ayakaleaf toolkit é o método de implementação recomendado para instalações locais da Community Edition, Ayakaleaf Pro; foi concebido para funcionar com o ambiente mais comum: um único servidor físico ou máquina virtual. O Toolkit usa `docker compose` para gerir os contentores Docker do seu servidor e fornece um conjunto de scripts que encapsulam `docker` comandos para ajudar com o lado mais técnico da gestão de uma versão local do Overleaf. #### O `bin/docker-compose` encapsulador O `bin/docker-compose` script é um encapsulador em torno de `docker compose`. Ele carrega a configuração de `config/` diretório, antes de invocar `docker compose` com quaisquer argumentos que tenham sido passados ao script. Pode tratar `bin/docker-compose` como um encapsulador transparente para o `docker compose` programa instalado na sua máquina. Exemplo: {% code title="Verificar contentores em execução" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Utilitários práticos Além de `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 uma shell dentro do **sharelatex** contentor * `bin/doctor`: script usado para recolher informações de instalação e implementação. Consulte a secção "Verificar o seu servidor" abaixo * `bin/mongo`: inicia uma shell dentro do **mongo** contentor e muda para a base de dados correta (**sharelatex**) * `bin/backup-config`: cria uma cópia (zip ou tar) da sua configuração atual e guarda-a num diretório de destino à sua escolha * `bin/logs`: ver/seguir os registos do serviço * `bin/error-logs`: ver/seguir os registos de erro do serviço * `bin/rename-env-vars-5-0`: script de migração para atualizar variáveis de ambiente em **config/variables.env** (rebranding de ShareLaTeX para Overleaf) * `bin/rename-rc-vars`: script de migração para atualizar variáveis de ambiente em **config/overleaf.rc** (rebranding de ShareLaTeX para Overleaf) * `bin/run-script`: utilitário para simplificar a execução de scripts armazenados no **sharelatex** contentor * `bin/upgrade`: ajuda nas atualizações da instância. O script verificará se há atualizações do Toolkit (via git) e oferecerá a opção de obter as alterações, verificará a versão mais recente da imagem Docker e oferecerá a atualização. Fornece confirmação passo a passo, a opção de fazer backup da configuração atual e trata de parar/iniciar os serviços Docker. Consulte Atualizar a sua implementação para mais informações: {% hint style="info" %} Se preferir executar a sua instância sem se ligar aos registos do Docker, pode executar `bin/up -d` para executar em modo desanexado. {% endhint %} #### Verificar o seu servidor O Overleaf Toolkit inclui um script útil chamado `bin/doctor` que produz um relatório apontando para qualquer dependência não satisfeita. Antes de continuar, execute o `bin/doctor` script e verifique se tudo está a funcionar corretamente: {% code title="Executar o Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Exemplo de saída (truncada/ilustrativa):
Exemplo de saída de bin/doctor ``` ====== Overleaf Doctor ====== - Informações do anfitrião - Linux - Saída de 'lsb_release -a': Não há módulos LSB disponíveis. ID do distribuidor: Ubuntu Descrição: Ubuntu 22.04.5 LTS Versão: 22.04 Nome de código: jammy - Dependências - bash - estado: presente - informação da versão: 5.1.16(1)-release - docker - estado: presente - informação da versão: Docker version 27.3.1, build ce12230 - realpath - estado: presente - informação da versão: realpath (GNU coreutils) 8.32 - perl - estado: presente - informação da versão: 5.034000 - awk - estado: presente - informação da versão: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - estado: presente - informação da versão: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022) - docker compose - estado: presente - informação da versão: Docker Compose version v2.29.7 - Docker Daemon - estado: em execução ====== Configuration ====== - config/version - estado: presente - versão: 5.1.1 - config/overleaf.rc - estado: presente - valores - OVERLEAF_DATA_PATH: data/overleaf - OVERLEAF_LOG_PATH: data/overleaf/logs - SERVER_PRO: true - com sessão iniciada em 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 - estado: presente - valores - OVERLEAF_FILESTORE_BACKEND: fs - OVERLEAF_HISTORY_BACKEND: fs ====== Avisos ====== - Nenhum, tudo bem ====== End ====== ```
Se alguma dependência estiver em falta, o doctor imprimirá avisos. Se tiver problemas, primeiro execute `bin/doctor` e verifique se a sua saída contém avisos. {% hint style="info" %} * Os utilizadores da Ayakaleaf Pro Edition podem abrir uma issue no GitHub: Em ambos os casos, inclua a saída de `bin/doctor` na sua mensagem. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ayakaleaf-pro.ayaka.space/on-premises/pt/primeiros-passos/what-is-the-overleaf-toolkit.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.