Skip to content

Commit 67ab610

Browse files
committed
docs(FR-2534): add 2FA/TOTP, SSO, and session extension to login documentation (#6572)
Resolves #6678 (FR-2534) ## Summary - Document **2FA/TOTP** authentication setup and verification flow - Document **SSO (Keycloak)** login via the "Login with Keycloak" button - Document **session extension** for users approaching session timeout - Add a note about concurrent session detection and automatic logout behavior - Apply reviewer fixes for accuracy and consistency across all 4 languages ## Changes - `login/login.md` (en/ko/ja/th): 2FA/TOTP section, SSO section, session extension section, concurrent session note ## Test plan - [ ] Verify 2FA setup steps match the actual TOTP flow - [ ] Verify SSO login button label matches the UI - [ ] Verify session extension notification behavior is accurately described 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent 573292d commit 67ab610

4 files changed

Lines changed: 90 additions & 28 deletions

File tree

packages/backend.ai-webui-docs/src/en/login/login.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ yet, click the `Sign up` link at the bottom of the dialog.
1010
![](../images/login_dialog.png)
1111

1212
Enter the required information, read and agree to the Terms of Service /
13-
Privacy Policy, and click the SIGNUP button. Depending on your system settings,
13+
Privacy Policy, and click the `Signup` button. Depending on your system settings,
1414
you may need to enter an invitation token to sign up. A verification email may
1515
be sent to verify that the email is yours. If the verification email is sent, you
1616
will need to read the email and click the link inside to pass verification
@@ -35,7 +35,7 @@ character(s).
3535

3636
## Log in
3737

38-
Enter your email (or username) and password, then click the **Login** button.
38+
Enter your email (or username) and password, then click the `Login` button.
3939

4040
![](../images/login_dialog.png)
4141

@@ -44,7 +44,7 @@ Enter your email (or username) and password, then click the **Login** button.
4444
### Connection Mode
4545

4646
If enabled by your administrator, a mode selector appears at the top of the
47-
login dialog allowing you to choose between **Session** mode and **API** mode.
47+
login dialog allowing you to choose between `Session` mode and `API` mode.
4848

4949
- **Session**: The standard login mode. Enter your email/username and password
5050
to authenticate. This is the default mode for most users.
@@ -55,7 +55,7 @@ login dialog allowing you to choose between **Session** mode and **API** mode.
5555

5656
### API Endpoint
5757

58-
Click the **Advanced** link to expand the endpoint configuration section. In the
58+
Click the `Advanced` link to expand the endpoint configuration section. In the
5959
API Endpoint field, enter the URL of the Backend.AI Webserver that relays
6060
requests to the Manager.
6161

@@ -75,7 +75,7 @@ know the user's password.
7575
### SSO Login (SAML / OpenID)
7676

7777
If your administrator has configured Single Sign-On (SSO), additional login
78-
buttons may appear below the standard **Login** button:
78+
buttons may appear below the standard `Login` button:
7979

8080
- **Login with SAML**: Authenticate using your organization's SAML identity
8181
provider.
@@ -119,21 +119,43 @@ For more details about enabling or disabling 2FA from your account settings,
119119
refer to the [2FA Setup](#2fa-setup) section in Top Bar Features.
120120
:::
121121

122+
<a id="concurrent-session-detection"></a>
123+
124+
### Concurrent Session Detection
125+
126+
If you attempt to log in while your account is already logged in from another
127+
browser or device, a confirmation dialog will appear informing you that an
128+
existing session is active. You can choose to end the existing session and
129+
proceed with the new login, or cancel to keep the existing session.
130+
131+
:::note
132+
This feature helps prevent unintended concurrent access to your account. If you
133+
see this dialog unexpectedly, it may indicate that someone else is using your
134+
credentials. In that case, proceed with the login to terminate the other session
135+
and consider changing your password.
136+
:::
137+
122138
After logging in, you can check the information of the current resource usage on
123139
the Start page.
124140

125141
By clicking the user icon in the upper-right corner, you will see the user menu.
126-
You can log out by selecting the **Log Out** menu item.
142+
You can log out by selecting the `Log Out` menu item.
127143

128144
![](../images/signout_button.png)
129145

146+
:::note
147+
If your system has a login session timer enabled, you will be automatically
148+
logged out when the timer expires. For details, see the
149+
[Login Session Timer](#login-session-timer) section in Top Bar Features.
150+
:::
151+
130152

131153
<a id="when-you-forgot-your-password"></a>
132154

133155
## When You Forgot Your Password
134156

135-
If you have forgotten your password, click the **Forgot password?** text and
136-
then the **Change** link on the login panel. A dialog will appear where you can
157+
If you have forgotten your password, click the `Forgot password?` text and
158+
then the `Change` link on the login panel. A dialog will appear where you can
137159
enter your email address to receive a password change link. Follow the
138160
instructions in the email to reset your password.
139161

packages/backend.ai-webui-docs/src/ja/login/login.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ WebUIを起動すると、ログインダイアログが表示されます。ま
88

99
![](../images/login_dialog.png)
1010

11-
必要な情報を入力し、利用規約/プライバシーポリシーを読み同意した上で、SIGNUPボタンをクリックしてください。システム設定によっては、サインアップに招待トークンを入力する必要がある場合があります。メールアドレスが本人のものであることを確認するための確認メールが送信されることがあります。確認メールが送信された場合は、メールを読んでリンクをクリックし、検証を通過してからアカウントでログインする必要があります。
11+
必要な情報を入力し、利用規約/プライバシーポリシーを読み同意した上で、`サインアップ`ボタンをクリックしてください。システム設定によっては、サインアップに招待トークンを入力する必要がある場合があります。メールアドレスが本人のものであることを確認するための確認メールが送信されることがあります。確認メールが送信された場合は、メールを読んでリンクをクリックし、検証を通過してからアカウントでログインする必要があります。
1212

1313
![](../images/signup_dialog.png)
1414

@@ -25,15 +25,15 @@ WebUIを起動すると、ログインダイアログが表示されます。ま
2525

2626
## ログイン
2727

28-
メールアドレス(またはユーザー名)とパスワードを入力し、**Login**ボタンをクリックします。
28+
メールアドレス(またはユーザー名)とパスワードを入力し、`ログイン`ボタンをクリックします。
2929

3030
![](../images/login_dialog.png)
3131

3232
<a id="connection-mode"></a>
3333

3434
### 接続モード
3535

36-
管理者が有効にしている場合、ログインダイアログの上部に**セッション**モードと**API**モードを選択できるモードセレクターが表示されます。
36+
管理者が有効にしている場合、ログインダイアログの上部に`セッション`モードと`API`モードを選択できるモードセレクターが表示されます。
3737

3838
- **セッション**: 標準的なログインモードです。メールアドレス/ユーザー名とパスワードを入力して認証します。ほとんどのユーザーにとってデフォルトのモードです。
3939
- **API**: APIキーペアを使用してログインします。メールアドレスとパスワードの代わりに**API Key****Secret Key**を入力します。プログラムからのアクセスに便利です。
@@ -42,7 +42,7 @@ WebUIを起動すると、ログインダイアログが表示されます。ま
4242

4343
### APIエンドポイント
4444

45-
**詳細設定**リンクをクリックすると、エンドポイント設定セクションが展開されます。APIエンドポイントフィールドに、リクエストをManagerに中継するBackend.AI WebserverのURLを入力します。
45+
`詳細設定`リンクをクリックすると、エンドポイント設定セクションが展開されます。APIエンドポイントフィールドに、リクエストをManagerに中継するBackend.AI WebserverのURLを入力します。
4646

4747
:::note
4848
Webサーバーのインストールおよびセットアップ環境によっては、エンドポイントが固定されており、設定ができない場合があります。
@@ -56,7 +56,7 @@ Backend.AIは、ユーザーのパスワードを一方向ハッシュを通じ
5656

5757
### SSOログイン (SAML / OpenID)
5858

59-
管理者がSSO(シングルサインオン)を設定している場合、標準の**Login**ボタンの下に追加のログインボタンが表示されることがあります。
59+
管理者がSSO(シングルサインオン)を設定している場合、標準の`ログイン`ボタンの下に追加のログインボタンが表示されることがあります。
6060

6161
- **SAMLログイン**: 組織のSAML IDプロバイダーを使用して認証します。
6262
- **[Realm名]ログイン**: OpenID Connectプロバイダーを使用して認証します。ボタンのラベルには管理者が設定したrealm名が表示されます。
@@ -89,18 +89,31 @@ TOTP設定後は、毎回のログイン時にOTPコードの入力が必要に
8989
アカウント設定での2FAの有効化・無効化の詳細については、トップバー機能の[2FA設定](#2fa-setup)セクションを参照してください。
9090
:::
9191

92+
<a id="concurrent-session-detection"></a>
93+
94+
### 同時セッションの検出
95+
96+
別のブラウザやデバイスで既にログインしている状態でログインを試みると、既存のセッションがアクティブであることを通知する確認ダイアログが表示されます。既存のセッションを終了して新しいログインを続行するか、キャンセルして既存のセッションを維持するかを選択できます。
97+
98+
:::note
99+
この機能は、アカウントへの意図しない同時アクセスを防止します。このダイアログが予期せず表示された場合は、他の誰かが資格情報を使用している可能性があります。その場合はログインを続行して他のセッションを終了し、パスワードの変更を検討してください。
100+
:::
101+
92102
ログイン後、スタートページで現在のリソース使用状況などの情報を確認できます。
93103

94-
右上のユーザーアイコンをクリックすると、ユーザーメニューが表示されます。**ログアウト**メニューを選択するとログアウトできます。
104+
右上のユーザーアイコンをクリックすると、ユーザーメニューが表示されます。`ログアウト`メニューを選択するとログアウトできます。
95105

96106
![](../images/signout_button.png)
97107

108+
:::note
109+
システムにログインセッションタイマーが有効になっている場合、タイマーが満了すると自動的にログアウトされます。詳細については、トップバー機能の[ログインセッションタイマー](#login-session-timer)セクションを参照してください。
110+
:::
98111

99112
<a id="when-you-forgot-your-password"></a>
100113

101114
## パスワードを忘れた場合
102115

103-
パスワードを忘れた場合、ログインパネルの**パスワードをお忘れですか?**テキストの横にある**パスワードを変更する**リンクをクリックします。メールアドレスを入力するダイアログが表示され、パスワード変更リンクが記載されたメールを受け取ることができます。メールの指示に従ってパスワードをリセットしてください。
116+
パスワードを忘れた場合、ログインパネルの`パスワードをお忘れですか?`テキストの横にある`パスワードを変更する`リンクをクリックします。メールアドレスを入力するダイアログが表示され、パスワード変更リンクが記載されたメールを受け取ることができます。メールの指示に従ってパスワードをリセットしてください。
104117

105118
![](../images/forgot_password_panel.png)
106119

packages/backend.ai-webui-docs/src/ko/login/login.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ WebUI를 실행하면 로그인 대화창이 나타납니다. 아직 가입을
2525

2626
## 로그인
2727

28-
이메일(또는 사용자 이름)과 비밀번호를 입력하고 **Login** 버튼을 클릭합니다.
28+
이메일(또는 사용자 이름)과 비밀번호를 입력하고 `로그인` 버튼을 클릭합니다.
2929

3030
![](../images/login_dialog.png)
3131

3232
<a id="connection-mode"></a>
3333

3434
### 연결 모드
3535

36-
관리자가 활성화한 경우, 로그인 대화창 상단에 **세션** 모드와 **API** 모드를 선택할 수 있는 모드 선택기가 나타납니다.
36+
관리자가 활성화한 경우, 로그인 대화창 상단에 `세션` 모드와 `API` 모드를 선택할 수 있는 모드 선택기가 나타납니다.
3737

3838
- **세션**: 표준 로그인 모드입니다. 이메일/사용자 이름과 비밀번호를 입력하여 인증합니다. 대부분의 사용자에게 기본 모드입니다.
3939
- **API**: API 키페어를 사용하여 로그인합니다. 이메일과 비밀번호 대신 **API Key****Secret Key**를 입력합니다. 프로그래밍 방식의 접근에 유용합니다.
@@ -42,7 +42,7 @@ WebUI를 실행하면 로그인 대화창이 나타납니다. 아직 가입을
4242

4343
### API 엔드포인트
4444

45-
**고급 설정** 링크를 클릭하면 엔드포인트 설정 섹션이 펼쳐집니다. API 엔드포인트 필드에 Manager로의 연결을 중계하는 Backend.AI Webserver의 URL을 입력합니다.
45+
`고급 설정` 링크를 클릭하면 엔드포인트 설정 섹션이 펼쳐집니다. API 엔드포인트 필드에 Manager로의 연결을 중계하는 Backend.AI Webserver의 URL을 입력합니다.
4646

4747
:::note
4848
Webserver의 설치 및 설정 환경에 따라, 엔드포인트가 고정되어 있을 수 있습니다.
@@ -56,7 +56,7 @@ Backend.AI는 사용자의 비밀번호를 단방향 해시를 통해 안전하
5656

5757
### SSO 로그인 (SAML / OpenID)
5858

59-
관리자가 SSO(Single Sign-On)를 설정한 경우, 표준 **Login** 버튼 아래에 추가 로그인 버튼이 나타날 수 있습니다.
59+
관리자가 SSO(Single Sign-On)를 설정한 경우, 표준 `로그인` 버튼 아래에 추가 로그인 버튼이 나타날 수 있습니다.
6060

6161
- **SAML 로그인**: 조직의 SAML ID 제공자를 사용하여 인증합니다.
6262
- **[Realm 이름] 로그인**: OpenID Connect 제공자를 사용하여 인증합니다. 버튼 레이블에는 관리자가 설정한 realm 이름이 표시됩니다.
@@ -89,17 +89,31 @@ TOTP 설정 이후에는 매 로그인 시 OTP 코드를 입력해야 합니다.
8989
계정 설정에서 2FA를 활성화하거나 비활성화하는 방법에 대한 자세한 내용은 상단 바 기능의 [이중 인증 설정](#2fa-setup) 섹션을 참고하세요.
9090
:::
9191

92+
<a id="concurrent-session-detection"></a>
93+
94+
### 동시 세션 감지
95+
96+
다른 브라우저나 기기에서 이미 로그인된 상태에서 로그인을 시도하면, 기존 세션이 활성 상태임을 알리는 확인 대화창이 나타납니다. 기존 세션을 종료하고 새로 로그인하거나, 취소하여 기존 세션을 유지할 수 있습니다.
97+
98+
:::note
99+
이 기능은 계정에 대한 의도치 않은 동시 접근을 방지합니다. 예상치 못하게 이 대화창이 나타나는 경우, 다른 사람이 사용자의 자격 증명을 사용하고 있을 수 있습니다. 이 경우 로그인을 진행하여 다른 세션을 종료하고 비밀번호를 변경하는 것을 권장합니다.
100+
:::
101+
92102
로그인이 완료되면 시작 페이지에서 현재 사용하고 있는 자원량 등의 정보를 확인할 수 있습니다.
93103

94-
우측 상단의 사용자 아이콘을 클릭하면 사용자 메뉴가 나타납니다. **로그아웃** 메뉴를 선택하여 로그아웃할 수 있습니다.
104+
우측 상단의 사용자 아이콘을 클릭하면 사용자 메뉴가 나타납니다. `로그아웃` 메뉴를 선택하여 로그아웃할 수 있습니다.
95105

96106
![](../images/signout_button.png)
97107

108+
:::note
109+
시스템에 로그인 세션 타이머가 활성화되어 있는 경우, 타이머가 만료되면 자동으로 로그아웃됩니다. 자세한 내용은 상단 바 기능의 [로그인 세션 타이머](#login-session-timer) 섹션을 참고하세요.
110+
:::
111+
98112
<a id="when-you-forgot-your-password"></a>
99113

100114
## 비밀번호를 잊어버렸을 경우
101115

102-
비밀번호를 잊어버렸을 경우, 로그인 패널의 **비밀번호를 잊어버렸습니까?** 텍스트 옆의 **비밀번호 재설정** 링크를 클릭합니다. 이메일 주소를 입력할 수 있는 대화창이 나타나며, 비밀번호 변경 링크가 포함된 이메일을 받을 수 있습니다. 이메일의 안내에 따라 비밀번호를 재설정합니다.
116+
비밀번호를 잊어버렸을 경우, 로그인 패널의 `비밀번호를 잊어버렸습니까?` 텍스트 옆의 `비밀번호 재설정` 링크를 클릭합니다. 이메일 주소를 입력할 수 있는 대화창이 나타나며, 비밀번호 변경 링크가 포함된 이메일을 받을 수 있습니다. 이메일의 안내에 따라 비밀번호를 재설정합니다.
103117

104118
![](../images/forgot_password_panel.png)
105119

0 commit comments

Comments
 (0)