Správa uživatelů

Vytvoření administrátorského uživatele

Nasazení pomocí 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"

Starší nasazení pomocí 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"

Příkaz vytvoří uživatele se zadanou e-mailovou adresou, pokud ještě neexistuje, a udělí mu roli administrátora. Výstup příkazu obsahuje URL, na které můžete pro tohoto uživatele nastavit heslo a poprvé se přihlásit.

Při programovém přístupu můžete stejný skript použít k vytváření běžných uživatelů i administrátorů. U běžných uživatelů vynechte příznak —admin.

Pokud k ověřování používáte interní účty a potřebujete stávajícího uživatele povýšit na administrátora instance nebo mu administrátorská oprávnění odebrat, postupujte takto:

Přes administrátorské rozhraní

Přihlaste se jako stávající administrátor.
Klikněte na Admin -> Manage Users.
Vyhledejte uživatele a klikněte na jeho e-mailovou adresu.
Sjeďte dolů do části Site Admin a klikněte na odkaz (show).
Zaškrtněte políčko Is Site Admin.
Dokončete kliknutím na Save.

Mazání uživatelů

Obecně se doporučuje účty nemazat, pokud nejsou opravdu nepotřebné. Smazáním účtu se účet odstraní a spolupracovníci ztratí přístup k projektům. V současnosti neexistuje způsob, jak účty deaktivovat — buď existují i se zachovanými daty, nebo jsou smazány. Ve výchozím nastavení se účty mažou měkce (soft delete). Informace o trvalém odstranění uživatelů z instance najdete u ENABLE_CRON_RESOURCE_DELETION v návodu Proměnné prostředí.

Účty se ve výchozím nastavení mažou měkce. Chování při trvalém mazání popisuje ENABLE_CRON_RESOURCE_DELETION.

Přes Admin -> Manage Users

Přihlaste se jako administrátor.
Klikněte na Admin -> Manage Users.
Vyhledejte uživatele a zaškrtněte políčko vedle jeho e-mailové adresy.
Klikněte na ikonu koše.
Potvrďte kliknutím na Delete.

Přes příkazový řádek

Uživatelské účty (a jejich projekty) lze smazat pomocí následujících příkazů. Nasazení pomocí 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"

Starší nasazení pomocí 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"

Skript pro mazání používá napevno nastavenou volbu force, která zajistí, že mazání proběhne, i když se nepodaří odeslat e-mail o smazání účtu (např. když e-mail uživatele již není v provozu).

Od verze 5.5.0 lze použít volbu —skip-email, která zabrání odeslání informačního e-mailu smazanému uživateli.

Obnovení měkce smazaného uživatele

Pokud byl uživatel smazán pouze měkce, můžete jeho účet a projekty obnovit.

Přihlaste se jako administrátor.
Klikněte na Admin -> Manage Users.
Vyhledejte uživatele, kterého chcete obnovit.
Klikněte na tlačítko Display deleted users.
Klikněte na e-mailovou adresu smazaného uživatele.
Klikněte na Recover This Account.
Potvrďte kliknutím na Recover.

Pokud je ENABLE_CRON_RESOURCE_DELETION nastaveno na true, lze měkce smazané účty obnovit do 90 dnů. Po uplynutí 90 dnů již obnovení účtu není možné.

Počítání uživatelů

Počty uživatelů můžete získat v administrátorském rozhraní na https://you-instance-url/admin/user#license. Pro programové kontroly a exporty mohou pomoci následující příklady. Celkový počet uživatelů:

Total number of users

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

Celkový počet uživatelů pomocí endpointu metrik:

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

Celkový počet aktivních uživatelů (příklad: uživatelé aktivní za posledních 365 dní):

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

Aktualizace informací o uživatelském účtu

Způsob aktualizace účtů závisí na tom, zda je zapnuto SSO.

Pokud se SSO nepoužívá:
- Administrátoři mohou upravovat informace o uživatelském účtu přes Admin -> Manage Users (e-mail, jméno, příjmení a vygenerování odkazu pro obnovení hesla).
- Běžní uživatelé mohou aktualizovat své vlastní údaje přes Account -> Account Settings (včetně změny hesla a generování ověřovacích tokenů pro Git).
Pokud se SSO používá:
- Server Pro lze nakonfigurovat tak, aby při přihlášení aktualizoval jméno a příjmení uživatele podle ověřovacího systému.
- Pokud jsou OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN nebo OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN nastaveny na true, formulář s údaji o uživateli na https://your-instance-url/user/settings je vypnutý a jméno a příjmení lze nastavit pouze ve vašem systému pro správu identit.

Další podrobnosti najdete zde:

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

Naposledy aktualizováno před 4 měsíci Tato stránka dokumentace obsahuje odkazy na externí návody a konfigurační stránky. Všechny odkazy a parametry dotazů jsou zachovány jako v původním obsahu.

Přehled

Instalace

Konfigurace

Údržba