Добавление пользователей Elph

Web-интерфейс Keycloak находится по адресу https://<ip-elph-proxy>/elph/auth/.
Для начала работы необходимо авторизоваться под учетной записью с правами администратора. После успешной авторизации будет отображена приветственная страница, в левой части которой расположено меню для управления различными объектами Keycloak.

Создание пользователей вручную

Для добавления пользователя необходимо выбрать домен, настроенный для работы с Elph. Этот домен должен соответствовать домену на IP-АТС ECSS-10. Для этого перейдите в меню «Manage Realms» и выберите свой домен.

После выбора домена откроется приветственная страница: «Welcome to <имя вашего домена>».

Далее перейдите в меню «Users». На этой странице будут отображены все пользователи, добавленные в этом домене, поле для поиска пользователя по имени и кнопка для добавления пользователя.

Нажмите на кнопку — отобразится страница с полями ввода параметров пользователя:

И заполните поля блоков «General» и «SIP настройки пользователя»:

• Обязательные настройки:
  • Username;
  • Phone Number;
  • SIP Login — логин пользователя на ECSS-10;
  • SIP Password — пароль пользователя на ECSS-10.
• Не обязательные настройки:
  
  • Email — используется для отображения почты пользователя;
  • First name, Last name, Middle name, Full name — используется для отображения фамилии, имени, отчества и полного ФИО;
  • avatarURL— используется для отображения аватара пользователя.
  • Title — используется для отображения должности пользователя.

Аватары пользователей можно хранить в корне папки /var/lib/ecss/ecss-elph-api/ на ECSS-10. Тогда в поле Avatar URL достаточно будет указать только имя файла. Также можно ссылаться на внешние источники, указывая прямую ссылку на изображение, например: http://eltex-co.ru/avatar.jpg. Поддерживаемые форматы: jpg, png, gif. Размеры и пропорции возможны любые, клиентское приложение само обрежет изображение под нужный размер. Рекомендуются квадратные изображения. Для удобства рекомендуется задавать такое же имя файла аватара, как и номер телефона пользователя, например 1001.jpg.

Заполните поля и нажмите кнопку .

После создания пользователя необходимо зайти во вкладку «Credentials» на этой же странице, и нажать кнопку . 

Появятся поля для ввода пароля и переключатель «Temporary», при включении которого пользователь должен будет сменить свой пароль при следующем входе в систему.

Импорт пользователей из LDAP

Также можно настроить импорт пользователей из LDAP в Keycloak. Для этого необходимо перенастроить Elph Chat Server, указав следующие значения в .env файле:

• LDAP_HOST
• LDAP_CONNECTION_URL
• LDAP_BIND_DN
• LDAP_BIND_CREDENTIALS
• LDAP_PROVIDER_UI_DISPLAY_NAME
• LDAP_USERS_DN
• LDAP_USERNAME_ATTRIBUTE
• LDAP_USER_RDN_ATTRIBUTE
• LDAP_USER_UUID_ATTRIBUTE
• LDAP_USER_OBJ_CLASSES
• LDAP_CUSTOM_USER_FILTER

Пример:

LDAP_HOST="192.168.108.182"
LDAP_CONNECTION_URL="ldap://${LDAP_HOST}"
LDAP_BIND_DN="cn=admin,dc=testing,dc=local"
LDAP_BIND_CREDENTIALS="password"
LDAP_PROVIDER_UI_DISPLAY_NAME="myLDAP"
LDAP_USERS_DN="dc=testing,dc=local"
LDAP_USERNAME_ATTRIBUTE="uid"
LDAP_USER_RDN_ATTRIBUTE="uid"
LDAP_USER_UUID_ATTRIBUTE="entryUUID"
LDAP_USER_OBJ_CLASSES="inetOrgPerson,organizationalPerson"
LDAP_CUSTOM_USER_FILTER="(&(objectClass=inetOrgPerson)(mail=*)(telephoneNumber=*))"

Обратите внимание, что для работы с Elph у пользователей LDAP обязательно должны быть атрибуты:

• mail
• telephoneNumber
• avatarURL

После перенастройки .env файла необходимо перезапустить контейнеры ECSS Chat Server:

<path-to-install-script>/ecss-elph-chat-server.sh down
<path-to-install-script>/ecss-elph-chat-server.sh up

Процесс импорта можно отслеживать в логах контейнера keycloak-configurator:

docker logs elph-keycloak-configurator -f

После успешного импорта в Keycloak добавятся все пользователи из LDAP, а также будет обеспечена минимальная синхронизация между LDAP и Keycloak, а именно:

• синхронизация вновь добавленных пользователей;
• синхронизация пользователей при использовании поиска в меню «Users».