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

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

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

./server task

для Windows:

server.exe task

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

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

для Windows:

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

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

  • add-admin-to-company — добавляет пользователя администратором в указанную компанию
  • change-email — изменяет email пользователя, для применения изменений пользователю необходимо заново авторизоваться в системе
  • change-user — позволяет сделать пользователя админом или наоборот, убрать из админов
  • check-data — проверяет корректность файлов данных YouGile
  • check-json — проверяет все файлы JSON в текущей директории
  • check-ldap — проверяет настройки интеграции с ActiveDirectory, т.е. по полям activeDirectory и activeDirectory в файле conf.json показывает список email-ов, которые подходят под критерии по AD
  • cleanup-database — чистит базу данных от удалённых задач
  • db-stats — показывает информацию по размеру данных компании
  • list-companies — показывает список всех компаний
  • list-users — показывает список пользователей YouGile
  • move-unused-files — сканирует папки database и user-data на наличие неиспользуемых файлов, перемещает неиспользуемые файлы в папку user-data-unused
  • set-password — позволяет установить пароль для пользователя (если нет интеграции с AD или управления через файл)
  • set-user-name – позволяет изменить отображаемое имя пользователя
  • show-license — показывает информацию о лицензии
  • show-updates — показывает список доступных обновлений (если есть доступ в интернет — обращается к dist.yougile.com)
  • update — обновляет YouGile (если есть доступ к dist.yougile.com)

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

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

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

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

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

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

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

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

  • add-admin-to-company
  • change-email
  • cleanup-database
  • move-unused-files
  • update

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

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

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

./server task list-users

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

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

./server task list-companies

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

systemctl stop yougile.service

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

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

Запустите сервиc 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 пользователя>