The User Settings page allows you to customize your Backend.AI WebUI experience. You can access it by clicking the person icon at the top right and selecting the Preferences menu. From here, you can configure preferences such as theme mode, language, desktop notifications, SSH keypair management, shell scripts, and experimental features.
The General tab contains all preference settings organized into groups: Preferences, Shell Environments, and Experimental features.
At the top of the settings area, you can use the search bar to quickly find a specific setting by name. Type a keyword, and only matching settings will be displayed.
You can also check the Display Only Changes checkbox to filter the list and show only settings that have been modified from their default values. This is useful for reviewing all customizations you have made at a glance.
To restore all settings to their default values, click the Reset to Default button at the top of the settings area. A confirmation dialog will appear before the reset is applied.
Each individual setting also has its own reset button (displayed when the value differs from the default), allowing you to reset a single setting without affecting others.
Select the display mode for the WebUI. You can choose from:
- Follow System: Automatically matches your operating system's light or dark mode setting.
- Light Mode: Always use the light theme.
- Dark Mode: Always use the dark theme.
Enables or disables the desktop notification feature. When turned on, Backend.AI uses the operating system's notification system in addition to in-app notifications. Turning this off does not affect notifications within the web UI. Depending on the operating system, notification permissions may need to be enabled in system settings.
When this option is on, the left sidebar will be shown in a compact form (narrower width). The change is applied when the browser is refreshed. If you want to immediately change the sidebar type without refreshing the page, click the leftmost icon at the top of the header.
Set the interface language. The language selector is a searchable dropdown that lists 20 languages: English, 한국어 (Korean), brasileiro (Brazilian Portuguese), 简体中文 (Simplified Chinese), 繁體中文 (Traditional Chinese), Français (French), Suomalainen (Finnish), Deutsch (German), Ελληνική (Greek), Bahasa Indonesia (Indonesian), Italiano (Italian), 日本語 (Japanese), Монгол (Mongolian), Polski (Polish), Português (Portuguese), русский (Russian), Español (Spanish), ภาษาไทย (Thai), Türkçe (Turkish), and Tiếng Việt (Vietnamese). You can type in the dropdown to filter and quickly find a language.
The language that matches your browser's default is indicated with a "(Default)" label next to its name. Languages other than English and Korean are provided via machine translation. Some UI items may not update their language before the page is refreshed.
:::note
Some translated items may be marked as __NOT_TRANSLATED__, which
indicates the item is not yet translated for that language. Since Backend.AI
WebUI is open sourced, anyone willing to help improve translations
can contribute: https://github.com/lablup/backend.ai-webui.
:::
:::note This setting is only available in the Electron (desktop) app. :::
When enabled, the WebUI app preserves your current login session information for the next app launch. If the option is turned off, login information will be cleared each time you log out.
A notification window pops up when a new WebUI version is detected. It works only in an environment where Internet access is available. If the feature is automatically disabled, clicking the toggle again will resume update checks.
Log out automatically when all Backend.AI WebUI pages are closed except for pages created to run apps in a session (e.g. Jupyter Notebook, web terminal, etc.).
Every user has at least one keypair. You can view your access key and secret key by clicking the Config button. Remember that only one main access keypair exists.
:::note Depending on the server version, the keypair information dialog may display a table view with additional management options such as issuing new keypairs, deactivating, or revoking existing ones. :::
:::note[Re-Login Required] When the main access key changes (for example, after issuing a new keypair and designating it as the main one), the WebUI shows a Re-Login Required notification with the message "The main access key has been changed. Please log in again to apply the change." Log out and sign in again so that the new main access key is applied to your session. :::
When using the WebUI app, you can create SSH/SFTP connections directly to a
compute session. Once you sign up for Backend.AI, a public keypair is
provided. If you click the button on the right of the SSH Keypair Management
section, the following dialog appears. Click the copy button on the right to
copy the existing SSH public key. You can update the SSH keypair by clicking
the GENERATE button at the bottom of the dialog. SSH public/private keys are
randomly generated and stored as user information. Please note that the secret
key cannot be checked again unless it is saved manually immediately after
creation.
:::note Backend.AI uses SSH keypair based on OpenSSH. On Windows, you may need to convert this into a PPK key. :::
From version 22.09, Backend.AI WebUI supports adding your own SSH keypair to
provide flexibility such as accessing a private repository. To add your own SSH
keypair, click the ENTER MANUALLY button. You will then see two text areas
corresponding to the "public" and "private" keys.
Enter the keys and click the SAVE button. You can now access your Backend.AI
session using your own key.
Limits the number of files that can be uploaded simultaneously through the File Explorer. You can select a value between 2 and 5. The default value is 2.
If you want to execute a one-time script just after your compute session starts, write down the contents here.
:::note
The compute session will remain in the PREPARING status until the bootstrap
script finishes its execution. Since you cannot use the session until it
is RUNNING, if the script contains long-running tasks, it might be
better to remove them from the bootstrap script and run them in a terminal
app.
:::
You can write config scripts to replace the default ones in a compute
session. Files like .bashrc, .tmux.conf.local, .vimrc, etc. can be
customized. The scripts are saved for each user and can be used when certain
automation tasks are required. For example, you can modify the .bashrc
script to register your command aliases or specify that certain files are always
downloaded to a specific location.
Use the drop-down menu at the top to select the type of script you want to write and then write the content. You can save the script by clicking the SAVE or SAVE AND CLOSE button. Click the DELETE button to delete the script.
Access new experimental features early -- these may change or be removed in future updates.
- AI Agents: Enable the AI Agents feature, which provides agent-based AI capabilities within the WebUI. When turned on, AI agent functionality becomes available for use in your sessions.
Displays detailed information of various logs recorded on the client side. You can visit this page to find out more about errors that occurred. You can search and filter error logs, refresh the list, and clear all logs by clicking the Clear Logs button at the top right.
:::note If you only have one page logged in, clicking the REFRESH button may not seem to work properly. The Logs page is a collection of requests to the server and responses from the server. If the current page is the Logs page, it will not send any requests to the server except when explicitly refreshing the page. To check that logs are being stacked properly, open another page and click the REFRESH button. :::
If you want to hide or show certain columns, click the gear icon at the bottom right of the table. A dialog will appear where you can select the columns you want to see.
