Eltex Documentation
Дерево страниц
Перейти к концу метаданных
Переход к началу метаданных

Автоматическая установка через скрипт с помощью docker compose

Скрипт предназначен для работы на debian подобных системах. Рекомендуется использовать ОС Ubuntu 20.04.

  1. Скачать скрипт ecss-clerk.sh одним из следующих способов:
# 1. С помощью утилиты curl:
$ curl -LsO "https://s3.eltex-co.ru/shared/clerk/ecss-clerk.sh"
# 2. С помощью утилиты wget:
$ wget "https://s3.eltex-co.ru/shared/clerk/ecss-clerk.sh" 
# 3. Вручную по ссылке: https://s3.eltex-co.ru/shared/clerk/ecss-clerk.sh

2. После скачивания необходимо определить исполняемые права для скрипта:

$ chmod +x ./ecss-clerk.sh

3. Выполнить следующие шаги для начала установки:

$ ./ecss-clerk.sh
$ cd clerk/stable
$ ./ecss-clerk.sh install

4. Следовать инструкциям и вопросам скрипта. Вот некоторые из них:

  • Если установка выполняется на системе без докера, то после его установки будет предложено сделать релогин в shell. Выполните его и повторите команду установки. Это сделано для того, чтобы доступ к докеру мог быть осуществим без sudo-прав от имени вашего пользователя;
  • Выполните логин в docker registry;
  • Выберите external host из предложенного списка. Это должен быть ваш внешний адрес, через который будет происходить обмен данными с другими хостами в вашей сети.

После установки появится список статусов установки всех образов для контейнеров:

Pulling pcm-manager       ... done
Pulling mongo             ... done
Pulling vosk-server       ... done
Pulling asr-server        ... done
Pulling keycloak-db       ... done
Pulling keycloak-importer ... done
Pulling keycloak          ... done
Pulling webbackend        ... done
Pulling clerk             ... done
Pulling nginx             ... done

5. Изменить в файле конфигурации clerk/stable/.env настройки по умолчанию на необходимые (подробнее о настройке файла конфигурации .env написано в пункте Конфигурация и описание переменных), основной параметр, который необходимо изменить — PB_URL, в котором указывается строка с ссылкой на актуальную адресную книгу:

$ sudo nano clerk/stable/.env
...
#####################################################
# Clerk
#####################################################
CLERK_PORT="8000"
PB_URL="http://192.168.100.200:28500/book.vcf" # пример ссылки, по которой доступна актуальная адресная книга

6. Запустить приложение:

$ ./ecss-clerk.sh up

При успешном запуске появится следующее сообщение:

Successfully start Clerk 2.2 in stable enviroment


При первом запуске приложение может работать некорректно, т. к. происходит адаптация модели под телефонную книгу. После запуска приложения необходимо подождать 20–30 мин.

Дополнительная информация о скрипте для установки

  • Compose-файлы и volume-ы хранятся в папке clerk;
  • Скрипт может обновить приложение до актуальной или желаемой версии. Для этого есть команда "update", например, если ввести ./ecss-clerk.sh update, то приложение выполнит обновление до актуальной стабильной версии, с помощью флага --version можно указать желаемую версию, например, ./ecss-clerk.sh update --version 2.2.0;
  • ./ecss-clerk.sh up — запуск приложения;
  • ./ecss-clerk.sh down — остановка приложения;
  • ./ecss-clerk.sh pull — обновить образы контейнеров;
  • ./ecss-clerk.sh download — обновить вспомогательные файлы (docker-compose, .env и т. д.).


  • Нет меток