diff --git a/README.md b/README.md index af6d464..3e38155 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -# ips_etl +# IPS ETL +## Описание +Этот проект представляет собой ETL процесс, который собирает данные из API и передаёт их на принимающую сторону. +## Установка и настройка +### Предварительные требования +- Docker +- Docker-compose +- Git + +### Шаги для запуска +1. Клонируйте репозиторий на вашу машину при помощи команды `git clone https://git.jsdio.ru/jsdio/ips_etl.git`. +2. Переименуйте файл `.env.dist` в `.env`. +3. Откройте файл `.env` и замените значения переменных на свои: + - `API_HOST`: адрес хоста API. + - `API_TOKEN`: токен API. + - `IBLOCKS`: список номеров инфоблоков через запятую без пробелов. + - `DESTINATION_HOST`: адрес хоста назначения. + - `DESTINATION_PORT`: порт назначения. + - `DESTINATION_PROTOCOL`: протокол назначения (http или https). + - `LAST_ID`: последний успешно обработанный ID. +4. После настройки переменных, запустите проект при помощи docker-compose командой `docker-compose up -d`. \ No newline at end of file