> For the complete documentation index, see [llms.txt](https://overleaf-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://overleaf-pro.ayaka.space/on-premises/ru/ustanovka/using-the-toolkit/2.-familiarize-yourself-with-the-toolkit.md).

# 2. Ознакомьтесь с Toolkit

### Осмотримся вокруг <a href="#taking-a-look-around" id="taking-a-look-around"></a>

Теперь, когда у вас есть локальная копия Toolkit, давайте посмотрим на структуру репозитория с помощью `ls` команды.

{% code title="Выполните это" %}

```bash
ls -l
```

{% endcode %}

{% hint style="info" %}
Поле `ls -l` команда отображает подробный длинный список содержимого каталога, предоставляя дополнительную информацию о файлах, такую как права доступа, владелец и размер.
{% endhint %}

Если всё было успешно клонировано, вы должны увидеть примерно следующее:

```
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
```

{% hint style="info" %}
Все файлы конфигурации, принадлежащие пользователю, находятся в `config/` каталоге. Этот каталог **исключён** из системы контроля версий git, поэтому он не будет изменён при обновлении Toolkit.
{% endhint %}

## Структура репозитория

| Имя      | Описание                                                                                                                                                                                                                                             |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bin`    | Эта папка содержит набор сценариев, которые помогают управлять экземпляром сервера Overleaf. Подробнее об этих сценариях можно прочитать в разделе Commands ниже.                                                                                    |
| `config` | В этой папке находятся ваши локальные файлы конфигурации.                                                                                                                                                                                            |
| `lib`    | В этой папке находятся базовые файлы конфигурации, используемые Toolkit.                                                                                                                                                                             |
| `data`   | По умолчанию эта папка содержит место хранения для MongoDb, Redis и Overleaf. Дополнительные сведения см. [Постоянные данные](https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/files-and-locations#persistent-data) раздел ниже. |

{% hint style="warning" %}
Мы рекомендуем **не** изменять файлы вне `/config` папки напрямую. Вместо этого, если вам нужно внести изменения, их можно сделать через переменные среды, заданные либо в **config/variables.env** или **config/overleaf.rc**.\
Например, чтобы задать `mongo` образ сервиса, вместо редактирования `lib/docker-compose.mongo.yml` напрямую, задайте образ с помощью переменной среды `MONGO_IMAGE` в `config/overleaf.rc`. Для получения дополнительной информации см. [Настройки Toolkit](broken://pages/323c16ad4fcd4a0baec4e6b6b832941e1d45b4bb) страницу.
{% endhint %}

{% hint style="info" %}
Toolkit будет **не** изменять любые данные в `config/` каталоге без вашего разрешения.
{% 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://overleaf-pro.ayaka.space/on-premises/ru/ustanovka/using-the-toolkit/2.-familiarize-yourself-with-the-toolkit.md?ask=<question>&goal=<endgoal>
```

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