Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 32 additions & 12 deletions packages/backend.ai-webui-docs/src/en/dashboard/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,71 @@ The **Dashboard** provides an at-a-glance summary of your current resource usage
available limits, and session information across all your projects and resource groups.
It helps you quickly understand how your computing resources are being utilized
and monitor your recent activities in the system.
Click the refresh icon in any panel to update the displayed data if it seems outdated.

![](../images/dashboard.png)

The page is composed of several main panels:

- My Sessions:
- **My Sessions**:
Shows the number of active sessions by type,
such as *Interactive*, *Batch*, *Inference*, and *Upload*.
You can quickly see how many sessions of each type are currently running.

- My Total Resources Limit:
- **My Total Resources Limit**:
Displays the total used and free resources across all your projects and resource groups.
When multiple limits (domain, project, or keypair) apply,
the system uses the **most restrictive** available limit to calculate the remaining resources.

- My Resources in Resource Group:
- **My Resources in Resource Group**:
Shows your current resource usage and remaining capacity
within the selected resource group of your current project.
You can switch groups using the dropdown menu.

- Total Resources in Resource Group:
- **Total Resources in Resource Group**:
Summarizes the overall used and free resources in the selected resource group.
The data is aggregated from all agents that belong to the group.

- Recently Created Sessions:
- **Recently Created Sessions**:
Lists the most recently created active sessions within the current project.
Provides session details such as name, status, CPU/memory usage, environment, resource group,
session type, and creation time.
By default, the latest 5 active sessions are displayed.

For super admins, additional information is available.
## Auto-Refresh

The Dashboard automatically refreshes all panel data every 15 seconds. This
ensures that the displayed information stays up to date without requiring manual
interaction.

## Customizing the Dashboard Layout

You can customize the Dashboard layout by rearranging and resizing panels to
suit your preferences.

- **Move panels**: Drag a panel by its header to reposition it on the board.
- **Resize panels**: Drag the bottom-right corner of a panel to adjust its
size. Each panel has a minimum size to ensure its content remains readable.

Your customized layout is automatically saved and persists across browser
sessions. The layout is stored per user, so each user can have their own
preferred arrangement.

## Superadmin Dashboard

For superadmins, additional panels are available.

![](../images/admin_dashboard.png)

Except for 'Active Sessions', 'Agent Statistics', and 'Active Agents', the remaining panels
Except for **Active Sessions**, **Agent Statistics**, and **Active Agents**, the remaining panels
display the same information as the user dashboard.

- Active Sessions:
- **Active Sessions**:
Shows the total number of active sessions across current projects,
categorized by session type.

- Agent Statistics:
- **Agent Statistics**:
Provides all used resources across all agents in the system.
The values represent the total used resources by all active sessions.

- Active Agents:
Lists all currently active agents in the system.
- **Active Agents**:
Lists all currently active agents in the system.
65 changes: 46 additions & 19 deletions packages/backend.ai-webui-docs/src/en/header/header.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,29 @@ The top bar includes various features that support use of the WebUI.

<a id="project-selector"></a>

## Project selector
## Project Selector


Users can switch between projects using the project selector provided in the top bar.
By default, the project that user currently belongs to is selected.
By default, the project that the user currently belongs to is selected.
Since each project may have different resource policies, switching projects may also change the available resource policies.

<a id="login-session-timer"></a>

## Login Session Timer

When login session management is enabled, the top bar displays the remaining
time until automatic logout along with an extend button. The timer shows the
time in `HH:mm:ss` format (or includes a day count if longer than 24 hours).

Click the extend button (refresh icon) next to the timer to reset the session
expiration and extend your login session.

:::note
The login session timer is only visible when the server supports login session
extension and it has been enabled in the system configuration.
:::

<a id="notification"></a>

## Notification
Expand All @@ -22,14 +38,14 @@ Since each project may have different resource policies, switching projects may
The bell shape button is the event notification button.
Events that need to be recorded during WebUI operation are displayed here.
When background tasks are running, such as creating a compute session,
you can check the jobs here. When the background task is finished.
you can check the jobs here.
Press the shortcut key (`]`) to open and close the notification area.

![](../images/notification_collapse.png)

<a id="theme-mode"></a>

## Theme mode
## Theme Mode


You can change the theme mode of the WebUI via the dark mode button on the
Expand All @@ -42,27 +58,38 @@ right side of the header.
## Help


Click question mark button to access the web version of this guide document.
Click the question mark button to access the web version of this guide document.
You will be directed to the appropriate documentation based on the page you are currently on.

<a id="responsive-layout"></a>

## Responsive Layout

On smaller screens, the top bar adjusts its layout for better usability. When
the screen width is narrow, the sidebar toggle is replaced with a menu icon
button in the top bar. The user's display name may also be hidden, showing only
the avatar icon for the user menu. The project label text is hidden on very
small screens.

<a id="user-menu"></a>

## User Menu


Click the person button on the right side of the top bar to see the user menu.
Click the user icon on the right side of the top bar to see the user menu.
Each menu item has the following functions.

![](../images/user_drop_down.png)

- About Backend.AI: Displays information such as version of Backend.AI WebUI,
- **About Backend.AI**: Displays information such as the version of Backend.AI WebUI,
license type, etc.
- My Account: Check / Update information of current login user.
- Preferences: Go to user settings page.
- Logs / Errors: Go to the log page. You can check the log and error history
recorded on the client side.
- Download Desktop App: Download the stand-alone WebUI app for your platform.
- Log Out: Log out of the WebUI.
- **My Account**: Check and update information of the current logged-in user.
- **Preferences**: Go to the user settings page.
- **Logs / Errors**: Go to the logs tab in the user settings page. You can check
the log and error history recorded on the client side.
- **Download Desktop App**: Download the stand-alone WebUI app for your platform.
This option is only visible when enabled by the administrator.
- **Log Out**: Log out of the WebUI.

<a id="my-account"></a>

Expand All @@ -75,18 +102,18 @@ If you click My Account, the following dialog appears.
Each item has the following meaning. Enter the desired value and click the UPDATE button to update the user
information.

- Full Name: User's name (up to 64 characters).
- Original password: Original password. Click the right view button to see the
- **Full Name**: User's name (up to 64 characters).
- **Original password**: Original password. Click the right view button to see the
input contents.
- New password: New password (8 characters or more containing at least 1
- **New password**: New password (8 characters or more containing at least 1
alphabet, number, and symbol). Click the right view button to see the input
contents. Ensure this is the same as the Original password.
- 2FA Enabled: 2FA activation. The user needs to enter the OTP code when logging in if it is checked.
- **2FA Enabled**: 2FA activation. The user needs to enter the OTP code when logging in if it is checked.


:::note
Depending on the plugin settings, the `2FA Enabled` column might be invisible.
In that case, please contact administrator of your system.
In that case, please contact the administrator of your system.
:::

<a id="2fa-setup"></a>
Expand All @@ -113,4 +140,4 @@ To log in, you must open the 2FA application and enter a 6-digit code in the One
![](../images/remove_2fa.png)

If you want to disable 2FA, turn off the `2FA Enabled` switch and click the confirm button in the
following dialog.
following dialog.
114 changes: 90 additions & 24 deletions packages/backend.ai-webui-docs/src/en/login/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

## Sign up

When you launch the WebUI, log in dialog appears. If you haven't signed up
yet, press the SIGN UP button.
When you launch the WebUI, the login dialog appears. If you haven't signed up
yet, click the `Sign up` link at the bottom of the dialog.

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

Expand All @@ -21,24 +21,43 @@ before you can log in with your account.

:::note
Depending on the server configuration and plugin settings, signing up by
anonymous user may not be allowed. In that case, please contact administrator
anonymous user may not be allowed. In that case, please contact the administrator
of your system.
:::

:::note
To prevent malicious users from guessing user's password, password should be longer
than 8 characters with at least one alphabet(s), number(s), and special
To prevent malicious users from guessing user's password, passwords must be
8 or more characters with at least one alphabet(s), number(s), and special
character(s).
:::

<a id="log-in"></a>

## Log in

Enter your ID and password and press the LOGIN button. In API ENDPOINT, the URL
of Backend.AI Webserver, which relays the request to the Manager, should be
entered.
Enter your email (or username) and password, then click the **Login** button.

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

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

### Connection Mode

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

- **Session**: The standard login mode. Enter your email/username and password
to authenticate. This is the default mode for most users.
- **API**: Log in using an API keypair. Enter your **API Key** and **Secret Key**
instead of email and password. This mode is useful for programmatic access.

<a id="api-endpoint"></a>

### API Endpoint

Click the **Advanced** link to expand the endpoint configuration section. In the
API Endpoint field, enter the URL of the Backend.AI Webserver that relays
requests to the Manager.

:::note
Depending on the installation and setup environment of the Webserver,
Expand All @@ -51,37 +70,84 @@ the default password hash of BSD, is used, so even the server admins cannot
know the user's password.
:::

After logging in, you can check the information of the current resource usage in
the Summary tab.
<a id="sso-login"></a>

### SSO Login (SAML / OpenID)

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

- **Login with SAML**: Authenticate using your organization's SAML identity
provider.
- **Login with [Realm Name]**: Authenticate using an OpenID Connect provider.
The button label shows the realm name configured by your administrator.

Click the appropriate SSO button to be redirected to your organization's
identity provider for authentication.

:::note
SSO login options are only visible when enabled by your system administrator.
:::

By clicking the icon in the upper-right corner, you will see sub menus. You
can logout by selecting the Log Out menu.
<a id="otp-login"></a>

### OTP Login (Two-Factor Authentication)

If two-factor authentication (2FA) is enabled for your account, an additional
OTP (One-Time Password) field appears after you enter your email and password.

![](../images/ask_otp_when_login.png)

Open your authenticator application (such as Google Authenticator, 1Password,
or Bitwarden) and enter the 6-digit code in the OTP field to complete login.

<a id="totp-setup-on-login"></a>

### TOTP Setup on First Login

If your administrator requires two-factor authentication and you have not yet
set up TOTP, a setup dialog will appear automatically after your first
successful login. Scan the QR code with your authenticator application or
manually enter the provided key, then enter the 6-digit verification code to
complete the setup.

After setting up TOTP, you will need to enter the OTP code on every subsequent
login.

:::note
For more details about enabling or disabling 2FA from your account settings,
refer to the [2FA Setup](#2fa-setup) section in Top Bar Features.
:::

After logging in, you can check the information of the current resource usage on
the Start page.

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

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


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

## When you forgot your password
## When You Forgot Your Password

If you have forgotten your password, you can click the CHANGE PASSWORD button on
the log in panel to email a link to change password. You can change your password
by reading and following the instruction. Depending on the server settings, the
password change feature may be disabled. In this case, contact the
administrator.
If you have forgotten your password, click the **Forgot password?** text and
then the **Change** link on the login panel. A dialog will appear where you can
enter your email address to receive a password change link. Follow the
instructions in the email to reset your password.

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


:::note
This is also a modular feature, so changing password may not be possible in
some systems.
Depending on the server configuration, the password change feature may not be
available. In that case, contact your administrator.
:::

:::warning
If log in failure occurs more than 10 times consecutively, access
If login failure occurs more than 10 times consecutively, access
to the endpoint is temporarily restricted for 20 minutes for security
reasons. If the access restriction continues on more than 20 minutes, please contact
reasons. If the access restriction continues after 20 minutes, please contact
your system administrator.
:::

Expand All @@ -96,4 +162,4 @@ Clicking it again will return the sidebar to its original width.
You can also use the shortcut key ( `[` ) to toggle between the narrow and original sidebar widths.


![](../images/menu_collapse.png)
![](../images/menu_collapse.png)
Loading
Loading