Käyttäjien hallinta

​

Ylläpitäjäkäyttäjän luominen

Overleaf Toolkit -käyttöönotot:

Overleaf Toolkit

$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/create-user --admin --email=[e-mail]"

Vanhat docker-compose.yml-käyttöönotot:

Legacy docker-compose

$ docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/create-user --admin --email=[e-mail]"

Komento luo käyttäjän annetulla sähköpostiosoitteella, jos sitä ei vielä ole, ja tekee siitä ylläpitäjän. Komennon tuloste sisältää URL-osoitteen, jossa voit asettaa käyttäjän salasanan ja kirjautua sisään ensimmäistä kertaa.

Ohjelmallisessa lähestymistavassa voit käyttää samaa skriptiä sekä tavallisten käyttäjien että ylläpitäjien luomiseen. Jätä tavallisten käyttäjien kohdalla —admin-lippu pois.

Jos käytät todennukseen sisäisiä tilejä ja haluat korottaa olemassa olevan käyttäjän instanssin ylläpitäjäksi tai poistaa ylläpitäjän oikeudet, toimi seuraavasti:

1. Ylläpitäjän käyttöliittymän kautta

   • Kirjaudu sisään olemassa olevana ylläpitäjänä.
   • Napsauta Admin -> Manage Users.
   • Hae käyttäjä ja napsauta hänen sähköpostiosoitettaan.
   • Vieritä alas Site Admin -osioon ja napsauta (show)-linkkiä.
   • Valitse valintaruutu Is Site Admin.
   • Viimeistele napsauttamalla Save.

---

​

Käyttäjien poistaminen

Yleensä tilejä ei kannata poistaa, ellei niitä enää tarvita. Tilin poistaminen poistaa tilin ja saa yhteistyökumppanit menettämään pääsyn projekteihin. Tällä hetkellä tilejä ei voi poistaa käytöstä — ne joko ovat olemassa tietoineen tai ne poistetaan.

Oletuksena tilit poistetaan pehmeästi (soft delete). Tietoja käyttäjien pysyvästä poistamisesta instanssistasi on muuttujan ENABLE_CRON_RESOURCE_DELETION kohdalla Ympäristömuuttujat-oppaassa.

Tilit poistetaan oletuksena pehmeästi. Katso pysyvän poiston toiminta muuttujasta ENABLE_CRON_RESOURCE_DELETION.

​

Admin -> Manage Users -näkymän kautta

1. • Kirjaudu sisään ylläpitäjänä.
   • Napsauta Admin -> Manage Users.
   • Hae käyttäjä ja valitse hänen sähköpostiosoitteensa vieressä oleva valintaruutu.
   • Napsauta roskakorikuvaketta.
   • Vahvista napsauttamalla Delete.

​

Komentorivin kautta

Käyttäjätilit (ja niiden projektit) voidaan poistaa seuraavilla komennoilla.

Overleaf Toolkit -käyttöönotot:

Overleaf Toolkit

$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/delete-user.mjs --email=[e-mail]"

Vanhat docker-compose.yml-käyttöönotot:

Legacy docker-compose

$ docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/delete-user.mjs --email=[e-mail]"

Poistoskripti käyttää kovakoodattua pakotusasetusta, joka varmistaa, että poisto etenee, vaikka tilin poistosta kertovan sähköpostin lähettäminen epäonnistuisi (esim. kun käyttäjän sähköpostiosoite ei ole enää käytössä).

Versiosta 5.5.0 lähtien asetuksella —skip-email voidaan estää tiedottavan sähköpostin lähettäminen poistetulle käyttäjälle.

---

​

Pehmeästi poistetun käyttäjän palauttaminen

Jos käyttäjä on poistettu vain pehmeästi, voit palauttaa hänen tilinsä ja projektinsa.

1. • Kirjaudu sisään ylläpitäjänä.
   • Napsauta Admin -> Manage Users.
   • Hae käyttäjä, jonka haluat palauttaa.
   • Napsauta Display deleted users -painiketta.
   • Napsauta poistetun käyttäjän sähköpostiosoitetta.
   • Napsauta Recover This Account.
   • Vahvista napsauttamalla Recover.

Kun ENABLE_CRON_RESOURCE_DELETION on asetettu arvoon true, pehmeästi poistetut tilit voidaan palauttaa 90 päivän kuluessa. 90 päivän jälkeen tilin palauttaminen ei ole mahdollista.

---

​

Käyttäjien laskeminen

Saat käyttäjämäärät ylläpitäjän käyttöliittymästä osoitteessa https://you-instance-url/admin/user#license. Ohjelmallisiin tarkistuksiin ja vienteihin seuraavista esimerkeistä voi olla apua.

Käyttäjien kokonaismäärä:

Total number of users

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

Käyttäjien kokonaismäärä metrics-päätepisteen avulla:

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

Aktiivisten käyttäjien kokonaismäärä (esimerkki: viimeisten 365 päivän aikana aktiiviset käyttäjät):

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

---

​

Käyttäjätilin tietojen päivittäminen

Tilin päivitysten tekotapa riippuu siitä, onko SSO käytössä.

• Jos SSO:ta ei käytetä:
  • Ylläpitäjät voivat muokata käyttäjätilin tietoja kohdassa Admin -> Manage Users (sähköposti, etunimi, sukunimi sekä salasanan palautuslinkin luominen).
  • Tavalliset käyttäjät voivat päivittää omat tietonsa kohdassa Account -> Account Settings (mukaan lukien salasanan vaihtaminen ja Git-todennustunnisteiden luominen).
• Jos SSO on käytössä:
  • Server Pro voidaan määrittää päivittämään käyttäjän etu- ja sukunimi kirjautumisen yhteydessä todennusjärjestelmän perusteella.
  • Kun OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN tai OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN on true, käyttäjätietolomake osoitteessa https://your-instance-url/user/settings on poistettu käytöstä, ja etu- ja sukunimen voi asettaa vain identiteetinhallintajärjestelmässäsi.

Lisätietoja:

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

---

Päivitetty viimeksi 4 kuukautta sitten

Tämä dokumentaatiosivu sisältää linkkejä ulkoisiin oppaisiin ja määrityssivuihin. Kaikki linkit ja kyselyparametrit on säilytetty alkuperäisen sisällön mukaisina.