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

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

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

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

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

$ chmod +x ./ecss-clerk

3. Перенести скрипт в директорию в /usr/bin/, чтобы он был доступен глобально :

$ sudo mv ecss-clerk /usr/bin/

4. Выполнить команду для начала установки:

$ sudo ecss-clerk install

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

  • Выполните логин в 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

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

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

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

$ sudo ecss-clerk up

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

Successfully start Clerk latest in stable enviroment


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

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

  • Compose-файлы и тома (volumes) хранятся в папке /etc/ecss/ecss-clerk/stable;
  • Скрипт может обновить приложение до актуальной или желаемой версии. Для этого есть команда "update", например, если ввести sudo ecss-clerk update, то приложение выполнит обновление до актуальной стабильной версии, с помощью флага --version можно указать желаемую версию, например, sudo ecss-clerk update --version 2.3.0;
  • sudo ecss-clerk up — запуск приложения;
  • sudo ecss-clerk down — остановка приложения;
  • sudo ecss-clerk pull — обновить образы контейнеров;
  • sudo ecss-clerk download — обновить вспомогательные файлы (docker-compose, .env и т. д.);
  • sudo ecss-clerk external-host — смена внешнего адреса приложения;
  • sudo ecss-clerk login — авторизация в docker registry.


  • Нет меток