Zarządzanie użytkownikami

Tworzenie użytkownika z uprawnieniami administratora

Wdrożenia z użyciem 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"

Starsze wdrożenia oparte na 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"

Polecenie utworzy użytkownika o podanym adresie e-mail, jeśli jeszcze nie istnieje, i nada mu uprawnienia administratora. Wynik polecenia zawiera adres URL, pod którym można ustawić hasło tego użytkownika i zalogować się po raz pierwszy.

W podejściu programistycznym możesz używać tego samego skryptu do tworzenia zarówno zwykłych użytkowników, jak i administratorów. W przypadku zwykłych użytkowników pomiń flagę —admin.

Jeśli do uwierzytelniania używasz kont wewnętrznych i chcesz nadać istniejącemu użytkownikowi uprawnienia administratora instancji lub je odebrać, wykonaj następujące czynności:

Za pomocą interfejsu administratora

Zaloguj się jako istniejący administrator.
Kliknij Admin -> Manage Users.
Wyszukaj użytkownika i kliknij jego adres e-mail.
Przewiń w dół do sekcji Site Admin i kliknij link (show).
Zaznacz pole Is Site Admin.
Kliknij Save, aby zakończyć.

Usuwanie użytkowników

Zasadniczo nie zaleca się usuwania kont, chyba że nie są już potrzebne. Usunięcie konta usuwa je i powoduje, że współpracownicy tracą dostęp do projektów. Obecnie nie ma możliwości dezaktywacji kont — konta albo istnieją wraz z zachowanymi danymi, albo są usuwane. Domyślnie konta są usuwane w sposób miękki (soft delete). Informacje o trwałym usuwaniu użytkowników z instancji znajdziesz w opisie ENABLE_CRON_RESOURCE_DELETION w przewodniku Zmienne środowiskowe.

Domyślnie konta są usuwane w sposób miękki. Zachowanie trwałego usuwania opisuje ENABLE_CRON_RESOURCE_DELETION.

Za pomocą Admin -> Manage Users

Zaloguj się jako administrator.
Kliknij Admin -> Manage Users.
Wyszukaj użytkownika i zaznacz pole obok jego adresu e-mail.
Kliknij ikonę kosza.
Kliknij Delete, aby potwierdzić.

Za pomocą wiersza poleceń

Konta użytkowników (wraz z ich projektami) można usunąć za pomocą następujących poleceń. Wdrożenia z użyciem 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"

Starsze wdrożenia oparte na 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"

Skrypt usuwania używa na stałe wpisanej opcji wymuszenia, która gwarantuje, że usunięcie zostanie przeprowadzone nawet wtedy, gdy nie uda się wysłać wiadomości e-mail o usunięciu konta (np. gdy adres e-mail użytkownika nie jest już aktywny).

Od wersji 5.5.0 można użyć opcji —skip-email, aby nie wysyłać do usuniętego użytkownika wiadomości informacyjnej.

Przywracanie użytkownika usuniętego w sposób miękki

Jeśli użytkownik został usunięty tylko w sposób miękki, możesz przywrócić jego konto i projekty.

Zaloguj się jako administrator.
Kliknij Admin -> Manage Users.
Wyszukaj użytkownika, którego chcesz przywrócić.
Kliknij przycisk Display deleted users.
Kliknij adres e-mail usuniętego użytkownika.
Kliknij Recover This Account.
Kliknij Recover, aby potwierdzić.

Gdy ENABLE_CRON_RESOURCE_DELETION ma wartość true, konta usunięte w sposób miękki można przywrócić w ciągu 90 dni. Po upływie 90 dni odzyskanie konta nie jest możliwe.

Zliczanie użytkowników

Liczbę użytkowników można sprawdzić w interfejsie administratora pod adresem https://you-instance-url/admin/user#license. Przy sprawdzaniu i eksportowaniu programistycznym pomocne mogą być poniższe przykłady. Całkowita liczba użytkowników:

Total number of users

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

Całkowita liczba użytkowników z użyciem punktu końcowego metryk:

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

Całkowita liczba aktywnych użytkowników (przykład: użytkownicy aktywni w ciągu ostatnich 365 dni):

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

Aktualizacja informacji o koncie użytkownika

Sposób aktualizacji kont zależy od tego, czy włączone jest SSO.

Jeśli SSO nie jest używane:
- Administratorzy mogą modyfikować informacje o koncie użytkownika w Admin -> Manage Users (adres e-mail, imię, nazwisko oraz generowanie linku do resetowania hasła).
- Zwykli użytkownicy mogą aktualizować własne dane w Account -> Account Settings (w tym zmieniać hasło i generować tokeny uwierzytelniania Git).
Jeśli SSO jest używane:
- Server Pro można skonfigurować tak, aby podczas logowania aktualizował imię i nazwisko użytkownika na podstawie systemu uwierzytelniania.
- Gdy OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN lub OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN mają wartość true, formularz danych użytkownika na stronie https://your-instance-url/user/settings jest wyłączony, a imię i nazwisko można ustawić wyłącznie w systemie zarządzania tożsamością.

Więcej szczegółów:

Konfiguracja SAML 2.0: https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/saml-2.0
Konfiguracja LDAP: https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/ldap

Ostatnia aktualizacja 4 miesiące temu Ta strona dokumentacji zawiera linki do zewnętrznych przewodników i stron konfiguracyjnych. Wszystkie linki i parametry zapytań zostały zachowane tak jak w oryginalnej treści.

Przegląd

Instalacja

Konfiguracja

Utrzymanie