Перейти к основному содержимому

Специальные команды YouGile

В YouGile есть набор команд, которые помогают выполнять часто встречающиеся задачи администрирования. Чтобы посмотреть список команд, в терминале, в директории yougile наберите:

./server task

Чтобы выполнить команду, необходимо в терминале перейти в директорию yougile и выполнить:

./server task <название команды> [параметры]

Доступные команды​

  • add-admin-to-company — добавляет пользователя администратором в указанную компанию
  • add-user <email> <name> <password> — создаёт нового пользователя с указанными email, именем и паролем
  • add-user-to-company <userId> <companyId> — добавляет существующего пользователя в указанную компанию
  • change-email <old email> <new email> — изменяет email пользователя; для применения изменений пользователю необходимо заново авторизоваться в системе
  • change-user <email> <companyId> — позволяет назначить пользователя администратором или убрать у него права администратора
  • change-user-auth-phone <email> <user phone> — добавляет или изменяет номер телефона пользователя
  • check-data — проверяет корректность файлов данных YouGile
  • check-json — проверяет все файлы JSON в текущей директории
  • check-ldap — проверяет настройки интеграции с ActiveDirectory: по параметрам activeDirectory и activeDirectoryOpts в файле conf.json показывает список email пользователей, соответствующих заданным критериям AD
  • cleanup-database — очищает базу данных от удалённых задач
  • db-stats — показывает информацию о размере данных компании
  • list-companies — показывает список всех компаний
  • list-users — показывает список пользователей YouGile
  • migration-from-cloud — запускает миграцию данных компании из облачной версии YouGile в коробочную
  • move-unused-files — сканирует папки database и user-data на наличие неиспользуемых файлов и перемещает их в папку user-data-unused
  • remove-duplicate-users — находит пользователей с одинаковым email и объединяет их в одну учётную запись — самую старую
  • remove-user <email> — удаляет учётную запись пользователя с указанным email
  • set-password <email> <new password> — позволяет установить пароль для пользователя, если не используется интеграция с Active Directory или управление пользователями через файл
  • set-user-name <email> <new username> — позволяет изменить отображаемое имя пользователя
  • show-license — показывает информацию о лицензии
  • show-updates — показывает список доступных обновлений; при наличии доступа в интернет обращается к dist.yougile.com
  • show-usage — показывает статистику активности пользователей по неделям с указанием количества активных пользователей за каждый период
  • update — обновляет YouGile при наличии доступа к dist.yougile.com

Запуск команд​

Некоторые команды можно выполнять при работающем сервисе, а другие требуют предварительной остановки.

Команды, выполняющиеся при работающем сервисе​

Эти команды обращаются к встроенному manage-интерфейсу и не влияют на работу компании:

  • change-user
  • change-user-auth-phone
  • check-data
  • check-json
  • check-ldap
  • db-stats
  • list-companies
  • list-users
  • set-password
  • set-user-name
  • show-license
  • show-updates
  • show-usage

Эти команды можно выполнять в любое время, yougile при этом остаётся доступен пользователям.

Команды, которые требуют остановки сервера​

Эти команды изменяют данные или структуру файлов, поэтому их нужно запускать только при остановленном сервисе:

  • add-admin-to-company
  • add-user-to-company
  • add-user
  • change-email
  • cleanup-database
  • move-unused-files
  • remove-duplicate-users
  • remove-user
  • update
  • migration-from-cloud

Примеры использования команд YouGile​

Добавление администратора​

Последовательно выполните команды:

./server task list-users

Убедитесь, что ваш пользователь, которому надо назначить права, есть в этом списке.

Выведите список компаний с их id:

./server task list-companies

Остановите сервис yougile:

systemctl stop yougile.service

Добавьте нужного пользователя:

./server task add-admin-to-company <id пользователя> <id компании>

Запустите сервис yougile:

systemctl start yougile.service

Удаление пользователя из компании​

Проверьте наличие пользователя в списке:

./server task list-users

⚠️ Обратите внимание: команда позволяет окончательно удалить аккаунт пользователя из компании.

./server task remove-user <e-mail пользователя>

Задать новый пароль для входа пользователя​

Команда устанавливает новый пароль для аккаунта пользователя, если не используется управления пользователями через файл или с помощью Active Directory. Пример:

./server task set-password <e-mail пользователя> <новый пароль>

Проверить правильность фильтра LDAP​

В параметре команды необходимо использовать значение вашего фильтра, например:

./server task check-ldap "&(objectClass=user)(mail=*)(memberOf=CN=Group,OU=yougile,DC=test,DC=local)"

, где часть "&(objectClass=user)(mail=*)(memberOf=CN=Group,OU=yougile,DC=test,DC=local)" это значение параметра "filter": "(&(objectClass=user)(mail=*)(memberOf=CN=Group,OU=yougile,DC=test,DC=local)" в conf.json. Фильтрацию можно проверять как целым блоком, так и разбивая на части, чтобы понять, где она отрабатывает корректно. В результате должен выдаваться список пользователей, подходящих под условия фильтра.

Узнать, в какие компании добавлен пользователь​

Команда позволяет получить список компаний, в которых состоит пользователь. Пример:

Узнать уникальный идентификатор пользователя (ID):

./server task list-users

Узнать, в какие компании добавлен пользователь:

./server task list-companies <ID пользователя>

Объединение дубликатов пользователей​

Команда находит пользователей с одинаковым email и заменяет дубликаты на самую раннюю учётную запись, перенося права, связи и задачи во всех компаниях.

⚠️ Важно: команду необходимо запускать только при остановленном сервисе.

Остановите сервис:

systemctl stop yougile.service

Выполните объединение дубликатов:

./server task remove-duplicate-users

Запустите сервис:

systemctl start yougile.service