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

Рекомендуется устанавливать чат-сервер на Ubuntu 20.04.

Для развертывания чат-сервера необходимо подключение к сети Ethernet. Для получения документации по развертыванию чат-сервера в закрытом контуре запросите документацию в коммерческом отделе компании Eltex.

Разворачивание докер-образа

Скачайте скрипт установки командой:

wget https://s3.eltex-co.ru/shared/elph-chat-server/ecss-elph-chat-server.sh

Выдайте права на исполнение:

chmod +x ecss-elph-chat-server.sh

Запустите скрипт, начнется загрузка:

./ecss-elph-chat-server.sh install

Если установка происходит удалённо по SSH, необходимо перелогиниться в терминале, так как пользователь был добавлен в группу docker, о чем будет получено уведомление:

Please, relogin in bash for access to docker group: 
$ su - user 
And repeat you command:

И повторить команду:

./ecss-elph-chat-server.sh install

В процессе установки будет необходимо авторизоваться во внешнем докер-регистре (данные авторизации вы можете уточнить в коммерческом отделе):

Enter docker registry user: 
Enter docker registry password:

И ответить на вопросы, предназначенные для правильной базовой настройки конфигурации сервера.

ВопросыПояснение или пример ответа
Enter your chat-server domain name or ip address. (Example: https://elph-chat.loc):

Введите доменное имя или IP-адрес чат-сервера в формате:  https://адрес_сервера или https://192.168.1.1:3443.

Enter ecss-web-api domain name or ip address. (Example: ecss-core.loc):Введите доменное имя или IP-адрес ecss-web-api.

Enter name of the ecss10 domain. (Example: default):

Введите имя домена.

Enter Adressbook domain or ip address. (Example: address-book.mysql.ecss):

Введите доменное имя или IP-адрес адресной книги.
Enter avatar-storage preffix patch. (Example: https://elphapi:8098/loadlocal/):

Введите адрес хранилища аватаров в формате https://адрес_elph_proxy/elph_api/loadlocal/(рекомендуется) или https://адрес_хранилища:8098/loadlocal/.


В случае правильного ввода конфигурационных настроек чат-сервер запустится автоматически. Об этом будет свидетельствовать следующее сообщение:

Successfully start Elph-chat-server latest in stable


Изменение конфигурации

Перед изменением конфигурации сначала остановите чат-сервер:

Для остановки чат сервера без очистки контейнеров и docker-network:

./ecss-elph-chat-server.sh stop

Для остановки чат сервера с очисткой контейнеров и docker-network:

./ecss-elph-chat-server.sh down

Обратите внимание! В версии 2.3.0 ./ecss-elph-chat-server.sh down очищает только контейнеры и docker-network. Для очистки базы данных полностью переустановите чат-сервер.

Изменить конфигурацию можно двумя способами:

  1.  Заново сконфигурировать при установке. Снова запустите скрипт с установкой:

    ./ecss-elph-chat-server.sh install

  2. Изменить файл конфигурации в ручную, подробнее об этом в разделе «Настройка чат-сервера»:

    Для этого остановите чат-сервер:

    ./ecss-elph-chat-server.sh down

    Измените конфигурацию:

    sudo nano elph-chat-server/stable/.env

    Запустите чат-сервер командой:

    ./ecss-elph-chat-server.sh up

Инструкция по установке чат-сервера на Astra Linux

Для установки чат-сервера необходимо предварительно установить следующие пакеты:

Версия должна быть не ниже 20.10.2

  • docker-compose

Версия должна быть не ниже 1.29.2

sudo apt install docker.io docker-compose

Следующие шаги установки не отличаются от штатных.

Обновление чат-сервера

Вместо переменной окружения TAG в приложении сервера теперь используется переменную окружения VSN.

Поэтому для просмотра версии чат-сервера воспользуйтесь командой:

docker logs elph-chat-server-stable_server_1

Пример вывода команды:

+-------------------------------------+
|            SERVER RUNNING           |
+-------------------------------------+
|                                     |
|  Version: 2.3.0.294                 |
|  NodeJS Version: 14.20.0 - x64      |
|  MongoDB: 4.4.19:wiredTiger         |
|  Platform: linux                    |
|  Process Port: 3000                 |
|  Access url: https://elph-chat.loc  |
|  API URL: https://192.168.107.180/  |
|  ReplicaSet OpLog: Enabled          |
|                                     |
+-------------------------------------+

В версии 2.3.0 было изменено расположение базы данных. При обновлении данные удалятся!

Поэтому для сохранения чатов и сообщений, необходимо сделать бэкап базы данных!

Для обновления чата-сервера:

  • сделайте бэкап базы с запущенного контейнера mongo:
docker exec elph-chat-server-stable_mongo_1 sh -c 'mongodump --archive' > dump.gz
  • остановите чат-сервер с очисткой контейнеров и данных:
./ecss-elph-chat-server.sh down
  • обновите чат-сервер:
./ecss-elph-chat-server.sh update
  • также для установки конкретной версии чат-сервера есть возможность использовать команду с указанием версии:
./ecss-elph-chat-server.sh update --version 2.3.0

Будьте осторожны при установке конкретной сборки чат-сервера. Downgrade в текущей версии чат-сервера не предусмотрен.

  • После обновления чат-сервера поправьте конфигурацию. А именно:
PUBLIC_URL=https://1.2.3.4 # 1.2.3.4 - адрес чат-сервера
ROOT_URL="https://elph-chat.loc" # оставить elph-chat.loc или указать полный адрес чат-сервера для доступа без прокси, по примеру: https://elph-chat.loc:3443
ECSS_CORE_HOST="2.3.4.5" # 2.3.4.5 - адрес ecss-core

Более подробно про параметры конфигурации вы можете почитать в Настройка чат-сервера.

  • Выгрузьте бэкап базы данных:
docker exec -i elph-chat-server-stable_mongo_1 sh -c 'mongorestore --archive --db elph --drop' < dump.gz
  • Перезагрузите чат-сервер:
./ecss-elph-chat-server.sh restart
  • Нет меток