ユーザー管理

​

管理者ユーザーの作成

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=[e-mail]"

従来の 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=[e-mail]"

このコマンドは、指定したメールアドレスのユーザーが存在しない場合は作成し、そのユーザーを管理者にします。コマンドの出力には URL が含まれており、そこにアクセスしてこのユーザーのパスワードを設定し、初回ログインを行うことができます。

プログラムで処理する場合は、同じスクリプトを使用して管理者だけでなく一般ユーザーも作成できます。一般ユーザーの場合は —admin フラグを省略してください。

認証に内部アカウントを使用しており、既存のユーザーをインスタンス管理者に昇格させたり、管理者権限を取り消したりする必要がある場合は、次の操作を行います：

1. 管理 UI から行う

   • 既存の管理者としてログインします。
   • Admin -> Manage Users をクリックします。
   • ユーザーを検索し、そのメールアドレスをクリックします。
   • Site Admin セクションまでスクロールし、(show) リンクをクリックします。
   • Is Site Admin のチェックボックスをオンにします。
   • Save をクリックして完了します。

---

​

ユーザーの削除

一般に、アカウントが不要になった場合を除き、アカウントは削除しないことをお勧めします。アカウントを削除するとアカウントが消去され、共同編集者はプロジェクトへのアクセスを失います。現在、アカウントを無効化する方法はありません。アカウントはデータを保持したまま存在するか、削除されるかのいずれかです。

デフォルトでは、アカウントはソフト削除されます。インスタンスからユーザーを完全に削除する方法については、環境変数ガイドの ENABLE_CRON_RESOURCE_DELETION を参照してください。

アカウントはデフォルトでソフト削除されます。完全削除の動作については ENABLE_CRON_RESOURCE_DELETION を参照してください。

​

Admin -> Manage Users から削除する

1. • 管理者としてログインします。
   • Admin -> Manage Users をクリックします。
   • ユーザーを検索し、そのメールアドレスの横にあるチェックボックスをオンにします。
   • ゴミ箱アイコンをクリックします。
   • Delete をクリックして確定します。

​

コマンドラインから削除する

ユーザーアカウント（およびそのプロジェクト）は、次のコマンドを使用して削除できます。

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=[e-mail]"

従来の 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=[e-mail]"

削除スクリプトはハードコードされた強制オプションを使用しており、アカウント削除のメール送信に失敗した場合（ユーザーのメールアドレスが使用されなくなっている場合など）でも削除が確実に実行されます。

バージョン 5.5.0 以降では、—skip-email オプションを使用して、削除されたユーザーへの通知メールの送信を抑止できます。

---

​

ソフト削除されたユーザーの復元

ユーザーがソフト削除されただけの場合は、そのアカウントとプロジェクトを復元できます。

1. • 管理者としてログインします。
   • Admin -> Manage Users をクリックします。
   • 復元したいユーザーを検索します。
   • Display deleted users ボタンをクリックします。
   • 削除されたユーザーのメールアドレスをクリックします。
   • Recover This Account をクリックします。
   • Recover をクリックして確定します。

ENABLE_CRON_RESOURCE_DELETION が true に設定されている場合、ソフト削除されたアカウントは 90 日以内であれば復元できます。90 日を過ぎると、アカウントを復元することはできません。

---

​

ユーザー数の集計

ユーザー数は、管理 UI の https://you-instance-url/admin/user#license で確認できます。プログラムによるチェックやエクスポートには、次の例が役立ちます。

ユーザーの総数：

Total number of users

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

メトリクスエンドポイントを使用したユーザーの総数：

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

アクティブユーザーの総数（例：過去 365 日以内にアクティブだったユーザー）：

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

---

​

ユーザーアカウント情報の更新

アカウントの更新方法は、SSO が有効かどうかによって異なります。

• SSO を使用していない場合：
  • 管理者は、Admin -> Manage Users からユーザーアカウント情報（メールアドレス、名、姓）を変更したり、パスワードリセットリンクを生成したりできます。
  • 一般ユーザーは、Account -> Account Settings から自分の情報を更新できます（パスワードの変更や Git 認証トークンの生成を含む）。
• SSO を使用している場合：
  • Server Pro は、ログイン時に認証システムに基づいてユーザーの名と姓を更新するように設定できます。
  • OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN または OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN が true の場合、https://your-instance-url/user/settings のユーザー詳細フォームは無効になり、名と姓は ID 管理システムでのみ設定できます。

詳細については、以下を参照してください：

• SAML 2.0 の設定：https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/saml-2.0
• LDAP の設定：https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/ldap

---

最終更新：4 か月前

このドキュメントページには、外部のガイドや設定ページへのリンクが含まれています。すべてのリンクとクエリパラメーターは元のコンテンツのまま保持されています。