Quản lý người dùng

Tạo người dùng quản trị viên

Với các bản triển khai 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"

Với các bản triển khai docker-compose.yml cũ:

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"

Lệnh này sẽ tạo một người dùng với địa chỉ email được cung cấp nếu người dùng đó chưa tồn tại, và đặt họ làm quản trị viên. Kết quả của lệnh bao gồm một URL mà bạn có thể truy cập để đặt mật khẩu cho người dùng này và đăng nhập lần đầu.

Nếu muốn thực hiện theo cách lập trình, bạn có thể dùng cùng script này để tạo người dùng thông thường cũng như quản trị viên. Đối với người dùng thông thường, hãy bỏ cờ —admin.

Nếu bạn sử dụng tài khoản nội bộ để xác thực và cần nâng quyền một người dùng hiện có thành quản trị viên phiên bản hoặc thu hồi quyền quản trị, hãy làm như sau:

Qua giao diện quản trị

Đăng nhập bằng một tài khoản quản trị viên hiện có.
Nhấp Admin -> Manage Users.
Tìm kiếm người dùng và nhấp vào địa chỉ email của họ.
Cuộn xuống phần Site Admin và nhấp vào liên kết (show).
Đánh dấu ô Is Site Admin.
Nhấp Save để hoàn tất.

Xóa người dùng

Nhìn chung, bạn không nên xóa tài khoản trừ khi chúng không còn cần thiết. Việc xóa một tài khoản sẽ loại bỏ tài khoản đó và khiến các cộng tác viên mất quyền truy cập vào các dự án. Hiện tại không có cách nào để vô hiệu hóa tài khoản — tài khoản hoặc tồn tại với dữ liệu được giữ lại, hoặc bị xóa. Theo mặc định, tài khoản được xóa mềm (soft-delete). Để biết thông tin về việc xóa vĩnh viễn người dùng khỏi phiên bản của bạn, hãy xem ENABLE_CRON_RESOURCE_DELETION trong hướng dẫn Biến môi trường.

Tài khoản được xóa mềm theo mặc định. Xem ENABLE_CRON_RESOURCE_DELETION để biết cách hoạt động của việc xóa vĩnh viễn.

Qua Admin -> Manage Users

Đăng nhập với tư cách quản trị viên.
Nhấp Admin -> Manage Users.
Tìm kiếm người dùng và đánh dấu ô bên cạnh địa chỉ email của họ.
Nhấp vào biểu tượng thùng rác.
Nhấp Delete để xác nhận.

Qua dòng lệnh

Có thể xóa tài khoản người dùng (và các dự án của họ) bằng các lệnh sau. Với các bản triển khai 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"

Với các bản triển khai docker-compose.yml cũ:

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"

Script xóa sử dụng một tùy chọn force được cố định sẵn, đảm bảo việc xóa vẫn được tiến hành ngay cả khi email thông báo xóa tài khoản không gửi được (ví dụ: khi email của người dùng không còn hoạt động).

Kể từ phiên bản 5.5.0, có thể dùng tùy chọn —skip-email để không gửi email thông báo đến người dùng bị xóa.

Khôi phục người dùng đã bị xóa mềm

Nếu một người dùng mới chỉ bị xóa mềm, bạn có thể khôi phục tài khoản và các dự án của họ.

Đăng nhập với tư cách quản trị viên.
Nhấp Admin -> Manage Users.
Tìm kiếm người dùng bạn muốn khôi phục.
Nhấp vào nút Display deleted users.
Nhấp vào địa chỉ email của người dùng đã bị xóa.
Nhấp Recover This Account.
Nhấp Recover để xác nhận.

Khi ENABLE_CRON_RESOURCE_DELETION được đặt thành true, các tài khoản bị xóa mềm có thể được khôi phục trong vòng 90 ngày. Sau 90 ngày, không thể khôi phục tài khoản.

Đếm số người dùng

Bạn có thể lấy số lượng người dùng qua giao diện quản trị tại https://you-instance-url/admin/user#license. Để kiểm tra và xuất dữ liệu theo cách lập trình, các ví dụ sau có thể hữu ích. Tổng số người dùng:

Total number of users

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

Tổng số người dùng khi dùng endpoint metrics:

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

Tổng số người dùng đang hoạt động (ví dụ: người dùng hoạt động trong vòng 365 ngày qua):

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

Cập nhật thông tin tài khoản người dùng

Cách thực hiện cập nhật tài khoản phụ thuộc vào việc SSO có được bật hay không.

Nếu không sử dụng SSO:
- Quản trị viên có thể sửa đổi thông tin tài khoản người dùng qua Admin -> Manage Users (email, tên, họ và tạo liên kết đặt lại mật khẩu).
- Người dùng thông thường có thể tự cập nhật thông tin của mình qua Account -> Account Settings (bao gồm đổi mật khẩu và tạo token xác thực Git).
Nếu sử dụng SSO:
- Server Pro có thể được cấu hình để cập nhật tên và họ của người dùng khi đăng nhập dựa trên hệ thống xác thực.
- Khi OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN hoặc OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN là true, biểu mẫu thông tin người dùng tại https://your-instance-url/user/settings sẽ bị vô hiệu hóa và tên/họ chỉ có thể được đặt trong hệ thống quản lý định danh của bạn.

Để biết thêm chi tiết, hãy xem:

Cấu hình SAML 2.0: https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/saml-2.0
Cấu hình LDAP: https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/ldap

Cập nhật lần cuối 4 tháng trước Trang tài liệu này chứa các liên kết đến hướng dẫn và trang cấu hình bên ngoài. Tất cả các liên kết và tham số truy vấn được giữ nguyên như trong nội dung gốc.

Tổng quan

Cài đặt

Cấu hình

Bảo trì