Керування користувачами

Створення користувача-адміністратора

Розгортання з 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 місяці тому Ця сторінка документації містить посилання на зовнішні посібники та сторінки налаштування. Усі посилання та параметри запитів збережено так само, як в оригінальному вмісті.

Огляд

Встановлення

Конфігурація

Обслуговування