Управление пользователями

Создание пользователя-администратора

Развёртывания Overleaf Toolkit:

Overleaf Toolkit

$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/create-user --admin --email=joe@example.com"

Устаревшие развёртывания с docker-compose.yml:

Legacy docker-compose

$ docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/create-user --admin --email=joe@example.com"

Команда создаст пользователя с указанным адресом электронной почты, если он ещё не существует, и сделает его администратором. Вывод команды содержит URL, по которому можно задать пароль этого пользователя и впервые войти в систему.

Для программной автоматизации тот же скрипт можно использовать для создания как обычных пользователей, так и администраторов. Для обычных пользователей не указывайте флаг —admin.

Если для аутентификации используются внутренние учётные записи и нужно повысить существующего пользователя до администратора экземпляра или отозвать права администратора, выполните следующее:

Через интерфейс администратора

Войдите в систему как существующий администратор.
Нажмите Admin -> Manage Users.
Найдите пользователя и нажмите на его адрес электронной почты.
Прокрутите вниз до раздела Site Admin и нажмите ссылку (show).
Установите флажок Is Site Admin.
Нажмите Save для завершения.

Удаление пользователей

Как правило, не рекомендуется удалять учётные записи, если они не стали окончательно ненужными. Удаление учётной записи удаляет её и приводит к тому, что соавторы теряют доступ к проектам. В настоящее время деактивировать учётные записи невозможно — они либо существуют с сохранёнными данными, либо удаляются. По умолчанию учётные записи удаляются мягко (soft delete). Сведения о безвозвратном удалении пользователей из вашего экземпляра см. в описании ENABLE_CRON_RESOURCE_DELETION в руководстве Переменные окружения.

По умолчанию учётные записи удаляются мягко. Сведения о безвозвратном удалении см. в описании ENABLE_CRON_RESOURCE_DELETION.

Через Admin -> Manage Users

Войдите в систему как администратор.
Нажмите Admin -> Manage Users.
Найдите пользователя и установите флажок рядом с его адресом электронной почты.
Нажмите на значок корзины.
Нажмите Delete для подтверждения.

Через командную строку

Учётные записи пользователей (и их проекты) можно удалить с помощью следующих команд. Развёртывания Overleaf Toolkit:

Overleaf Toolkit

$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/delete-user.mjs --email=joe@example.com"

Устаревшие развёртывания с docker-compose.yml:

Legacy docker-compose

$ docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/delete-user.mjs --email=joe@example.com"

Скрипт удаления использует жёстко заданный параметр принудительного удаления, благодаря которому удаление выполняется, даже если письмо об удалении учётной записи не удалось отправить (например, когда адрес электронной почты пользователя больше не действует).

Начиная с версии 5.5.0 можно использовать параметр —skip-email, чтобы не отправлять удалённому пользователю информационное письмо.

Восстановление мягко удалённого пользователя

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

Войдите в систему как администратор.
Нажмите Admin -> Manage Users.
Найдите пользователя, которого нужно восстановить.
Нажмите кнопку Display deleted users.
Нажмите на адрес электронной почты удалённого пользователя.
Нажмите Recover This Account.
Нажмите Recover для подтверждения.

Если ENABLE_CRON_RESOURCE_DELETION имеет значение true, мягко удалённые учётные записи можно восстановить в течение 90 дней. По истечении 90 дней восстановление учётной записи невозможно.

Подсчёт пользователей

Количество пользователей можно узнать через интерфейс администратора по адресу https://you-instance-url/admin/user#license. Для программных проверок и экспорта могут пригодиться следующие примеры. Общее количество пользователей:

Total number of users

echo 'db.users.countDocuments()' | docker exec -i mongo mongosh --quiet localhost/sharelatex
# overleaf [direct: primary] sharelatex> 16

Общее количество пользователей через эндпоинт метрик:

Num active users from metrics

docker exec sharelatex curl http://127.0.0.1:3000/metrics | grep num_active_users
# # HELP num_active_users num_active_users
# # TYPE num_active_users gauge
# num_active_users{app="web-api",host="b3ae4ff549d8"} 16

Общее количество активных пользователей (пример: пользователи, активные за последние 365 дней):

Total number of active users

echo 'db.users.countDocuments({ lastActive: { $gte: new Date(new Date().getTime() - (365 * 24 * 60 * 60 * 1000)) } })' | docker exec -i mongo mongosh --quiet localhost/sharelatex
# overleaf [direct: primary] sharelatex> 10

Изменение сведений учётной записи пользователя

Способ изменения учётных записей зависит от того, включён ли SSO.

Если SSO не используется:
- Администраторы могут изменять сведения учётной записи пользователя через Admin -> Manage Users (адрес электронной почты, имя, фамилию, а также создавать ссылку для сброса пароля).
- Обычные пользователи могут изменять свои данные через Account -> Account Settings (включая смену пароля и создание токенов аутентификации Git).
Если SSO используется:
- Server Pro можно настроить так, чтобы при входе имя и фамилия пользователя обновлялись на основе данных системы аутентификации.
- Если OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN или OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN имеют значение true, форма сведений о пользователе на https://your-instance-url/user/settings отключается, и имя/фамилию можно задать только в вашей системе управления идентификацией.

Подробнее см.:

Настройка SAML 2.0: https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/saml-2.0
Настройка LDAP: https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/ldap

Последнее обновление: 4 месяца назад Эта страница документации содержит ссылки на внешние руководства и страницы конфигурации. Все ссылки и параметры запросов сохранены в том виде, в каком они были в исходном содержимом.

Обзор

Установка

Настройка

Обслуживание