Manajemen pengguna

Membuat pengguna administrator

Penerapan 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"

Penerapan docker-compose.yml lama (legacy):

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"

Perintah ini akan membuat pengguna dengan alamat email yang diberikan jika pengguna tersebut belum ada, dan menjadikannya administrator. Output perintah menyertakan URL yang dapat Anda kunjungi untuk mengatur kata sandi pengguna ini dan masuk untuk pertama kalinya.

Untuk pendekatan terprogram, Anda dapat menggunakan skrip yang sama untuk membuat pengguna biasa maupun administrator. Untuk pengguna biasa, hilangkan flag —admin.

Jika Anda menggunakan akun internal untuk autentikasi dan perlu menaikkan pengguna yang sudah ada menjadi admin instans atau mencabut izin admin, lakukan hal berikut:

Melalui UI Admin

Masuk sebagai administrator yang sudah ada.
Klik Admin -> Manage Users.
Cari pengguna dan klik alamat email mereka.
Gulir ke bawah ke bagian Site Admin dan klik tautan (show).
Centang kotak Is Site Admin.
Klik Save untuk menyelesaikan.

Menghapus pengguna

Secara umum disarankan untuk tidak menghapus akun kecuali akun tersebut sudah tidak diperlukan lagi. Menghapus akun akan menghilangkan akun tersebut dan menyebabkan kolaborator kehilangan akses ke proyek. Saat ini tidak ada cara untuk menonaktifkan akun — akun hanya bisa tetap ada dengan datanya dipertahankan, atau dihapus. Secara default, akun dihapus secara lunak (soft-delete). Untuk informasi tentang menghapus pengguna secara permanen dari instans Anda, lihat ENABLE_CRON_RESOURCE_DELETION di panduan Variabel lingkungan.

Akun dihapus secara lunak (soft-delete) secara default. Lihat ENABLE_CRON_RESOURCE_DELETION untuk perilaku penghapusan permanen.

Melalui Admin -> Manage Users

Masuk sebagai administrator.
Klik Admin -> Manage Users.
Cari pengguna dan centang kotak di samping alamat email mereka.
Klik ikon tempat sampah.
Klik Delete untuk mengonfirmasi.

Melalui baris perintah

Akun pengguna (beserta proyek-proyeknya) dapat dihapus menggunakan perintah berikut. Penerapan 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"

Penerapan docker-compose.yml lama (legacy):

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"

Skrip penghapusan menggunakan opsi force yang ditanamkan langsung (hard-coded) untuk memastikan penghapusan tetap berjalan meskipun email penghapusan akun gagal dikirim (misalnya, ketika email pengguna sudah tidak aktif).

Sejak versi 5.5.0, opsi —skip-email dapat digunakan untuk mencegah pengiriman email pemberitahuan kepada pengguna yang dihapus.

Memulihkan pengguna yang dihapus secara lunak

Jika seorang pengguna hanya dihapus secara lunak, Anda dapat memulihkan akun dan proyek-proyeknya.

Masuk sebagai administrator.
Klik Admin -> Manage Users.
Cari pengguna yang ingin Anda pulihkan.
Klik tombol Display deleted users.
Klik alamat email pengguna yang dihapus.
Klik Recover This Account.
Klik Recover untuk mengonfirmasi.

Ketika ENABLE_CRON_RESOURCE_DELETION diatur ke true, akun yang dihapus secara lunak dapat dipulihkan dalam jangka waktu 90 hari. Setelah 90 hari, pemulihan akun tidak lagi dimungkinkan.

Menghitung pengguna

Anda dapat memperoleh jumlah pengguna melalui UI admin di https://you-instance-url/admin/user#license. Untuk pemeriksaan dan ekspor terprogram, contoh-contoh berikut mungkin membantu. Jumlah total pengguna:

Total number of users

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

Jumlah total pengguna menggunakan endpoint 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

Jumlah total pengguna aktif (contoh: pengguna yang aktif dalam 365 hari terakhir):

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

Memperbarui informasi akun pengguna

Cara pembaruan akun dilakukan bergantung pada apakah SSO diaktifkan.

Jika SSO tidak digunakan:
- Administrator dapat mengubah informasi akun pengguna melalui Admin -> Manage Users (email, nama depan, nama belakang, dan membuat tautan reset kata sandi).
- Pengguna biasa dapat memperbarui detail mereka sendiri melalui Account -> Account Settings (termasuk mengubah kata sandi dan membuat token autentikasi Git).
Jika SSO digunakan:
- Server Pro dapat dikonfigurasi untuk memperbarui nama depan dan nama belakang pengguna saat login berdasarkan sistem autentikasi.
- Ketika OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN atau OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN bernilai true, formulir detail pengguna di https://your-instance-url/user/settings dinonaktifkan dan nama depan/belakang hanya dapat diatur di sistem manajemen identitas Anda.

Untuk detail lebih lanjut, lihat:

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

Terakhir diperbarui 4 bulan yang lalu Halaman dokumentasi ini berisi tautan ke panduan eksternal dan halaman konfigurasi. Semua tautan dan parameter kueri dipertahankan seperti pada konten aslinya.

Ikhtisar

Instalasi

Konfigurasi

Pemeliharaan