--- myst: html_meta: "description lang=en": "Using Kasm Workspaces User Profile: User Guide, User Settings, Profile Details, Reset Password, Group Membership, Settings, SSH Keys, Session History" "keywords": "Kasm, Workspaces, User Guide, User Profile, User Settings, Profile Details, Reset Password, Group Membership, Settings, SSH Keys, Session History" "property=og:locale": "en_US" --- ```{title} User Profile ``` # User Profile In the Edit User Profile screen you can manage various aspects of your Kasm Workspaces account. Let's explore the available options and settings. ```{figure} /images/user_guide/profile/profile_details.webp :align: center **Edit Profile Screen** ``` ## Accessing Your Profile To access your user profile, click on the round icon in the top right corner of the dashboard, and then select `Edit Profile`. You can also sign out of your account by clicking the `Sign Out` button. ```{figure} /images/user_guide/profile/edit_profile.webp :align: center **Edit Profile Button Location** ``` The list provided represents a set of actions or options available within the user profile section of Kasm Workspaces. Here's what each item in the list refers to: * **View Profile Details:** This option allows users to access and view their profile details, which typically include information such as username, first name, last name, organization, phone number, and last session details. * **Change your password:** Users can select this option to modify their current password and set a new one for their Kasm Workspaces account. It usually involves entering the current password, followed by the desired new password and confirmation. * **Change Settings:** This option enables users to customize various settings related to their Kasm Workspaces experience. It typically includes preferences such as auto-launching sessions, chat sound effects, default workspace image, session tips display, control panel behavior, and theme selection. * **Change or add SSH Keys:** Users can manage their SSH keys through this option. It allows them to add new SSH key pairs or update the existing ones. SSH keys are used for secure authentication and access to Kasm Workspaces sessions. * **View session history:** This option provides users with access to their session history, displaying details about their past sessions, including the workspace image used, session creation time, session stop time, the user who stopped the session, and the duration of each session. ```{note} These options give users control over their profile details, security settings, SSH keys, and provide insights into their session history within Kasm Workspaces. ``` ## Profile Details In the profile details section, you can view and update your personal information, including: * User Name * First Name * Last Name * Organization * Phone * Last Session ```{figure} /images/user_guide/profile/profile_details_2.webp :align: center **Profile Details Section** ``` ### Resetting Your Password If you need to change your password, follow these steps: 1. Click on the `Reset Password` button located in the top right corner. 2. Enter your current password, followed by your new password and confirmation. 3. Click `Save` to update your password. ```{figure} /images/user_guide/profile/reset_password.webp :align: center **Resetting Password Options** ``` ### Group Membership Under the `Last Session` tab, you'll find the groups you are a member of. To learn more about groups, visit the {doc}`Groups Section <../guide/groups>`. ```{figure} /images/user_guide/profile/groups.webp :align: center **Groups** ``` ## Settings The settings section allows you to customize various aspects of your Kasm Workspaces experience. ```{figure} /images/user_guide/profile/settings.webp :align: center **Settings Section** ``` ### Auto Launch Session By enabling this setting **(default: off)**, Kasm Workspaces will automatically launch a session for you upon login. The default workspace image will be used. ### Chat Sound Effects You can enable sound effects for chat during shared sessions with this option. Click here for more info on {doc}`Shared Sessions <../guide/session_sharing>`. ### Default Workspace Image The default Workspace image is used in two scenarios. 1. If you have the `Auto Launch Session` setting enabled, this default image will be used. 2. If you have the Kasm Browser Extension installed, you can right-click on a link and select `Open Link in Kasm` to open the link using the default workspace image. To learn more about Kasm Open In Isolation Browser Extension , visit the {doc}`Open In Isolation Browser Extension Section <../how_to/kasm_extension>`. ```{figure} /images/user_guide/profile/default_image.webp :align: center **Default Images Section** ``` ### Show Tips During Session Enabling this setting **(default: off)** will display helpful tips when launching a Kasm session. ### Toggle Control Panel By enabling this setting **(default: off)**, you can open and close the control panel within a Kasm session by double-clicking the CTRL key. ```{figure} /images/user_guide/profile/settings_2.webp :align: center **Settings Section Continued** ``` ### Theme You can adjust the app theme to your preference. The options include: * **Auto:** Automatically follows your system's OS theme settings. * **Dark:** Switches to a dark theme. * **Light:** Switches to a light theme. ```{figure} /images/user_guide/profile/theme.webp :align: center **Theme Section** ``` ### Kasm UI Language The user can adjust their preferred language for the UI, this is seperate from the language inside a Kasm session, which is modified in the dropdown below. ```{figure} /images/user_guide/profile/ui_language_dropdown.webp :align: center **Changing Kasm UI Language** ``` ### Kasm Session Language The user can adjust their preferred language for Kasm sessions. For container based sessions this language will be used unless the administrator has set the LC_ALL environment variable in the run_config setting for one of the user's groups or the workspace configuration. For Kasm connection proxy SSH sessions the language will be used unless the administrator has set the locale setting in connection_info on the server or modified the default global setting. This dropdown has an 'Auto' setting that will autodetect the user's language set in the browser and use that for the Kasm session. In Kasm Workspaces 1.14.0 many locales were added to the Kasm containerized workspaces in the official Workspaces Registry. ```{figure} /images/user_guide/profile/session_language_dropdown.webp :align: center **Changing Kasm Session Language** ``` ### Kasm Session Timezone The user can adjust their preferred timezone for Kasm sessions. For container based sessions this timezone will be used unless the administrator has set the TZ environment variable in the run_config setting for one of the user's groups or the workspace configuration. For Kasm connection proxy RDP and SSH sessions the timezone will be used unless the administrator has set the timezone setting in connection_info on the server or modified the default global setting. This dropdown has an 'Auto' setting that will autodetect the user's timezone set in the browser and use that for the Kasm session. ```{figure} /images/user_guide/profile/session_timezone_dropdown.webp :align: center **Changing Kasm Session Timezone** ``` ## SSH Keys Manage your SSH keys in this section. You have the following options: ### SSH Public Key The SSH public key is automatically injected into each new Kasm session, provided it's allowed by the administrator's policies. ```{figure} /images/user_guide/profile/ssh.webp :align: center **SSH Section** ``` ### New Key Pair Update the SSH key pair that gets automatically injected into each new Kasm session, subject to the administrator's policies. ```{figure} /images/user_guide/profile/ssh_upload.webp :align: center **Changing Key Pair Section** ``` ## Session Usage The session Usage displays your usage data for the past 30 days. You can customize the number of rows per page to improve readability. Available options include: * 5 * 10 * 25 * 50 * 100 The session usage details include the following information: * **Image:** The workspace image used. * **Created:** The timestamp when the session was created. * **Stopped On:** The timestamp when the session was stopped. * **Stopped By:** The user who stopped the session. * **Usage (hours):** The total duration of the session in hours. ```{figure} /images/user_guide/profile/usage.webp :align: center **Session Usage Section** ``` (user-cloud-storage)= ## Cloud Storage If enabled by the administrator, a **Cloud Storage** section will be visible in the profile. This panel allows users to register accounts for popular cloud storage providers that will then be automatically attached to new container-based sessions. The following services are available if enabled by the administrator - **Google Drive** - **Microsoft OneDrive** - **Dropbox** - **Nextcloud** - **AWS S3** Clicking **Add Storage Mapping**, will bring up a form to begin configuring access to the cloud storage providers offered by the administator. ```{figure} /images/storage_mapping/profile_add_storage_mapping.png :align: center **Add Storage Mapping** ``` Configure the details as desired. Authentication for some storage providers (Google Drive, OneDrive, Dropbox) will be handled by the providers themselves. - **Enabled** : When enabled the Cloud Storage Mapping will be used on all new sessions. - **Read Only**: When enabled the Cloud Storage Mapping will be accessible in a read only fashion. Adding , modifying or deleting files will not be allowed. ```{note} Adminstrators may force cloud storage mappings to be Read Only, regardless of the setting specified here. ``` ```{figure} /images/storage_mapping/dropbox/configure_storage.webp :align: center **Configure Storage Mapping** ``` Once configured, the storage mappings are available to be updated or deleted from the Cloud Storage section of the profile. ```{figure} /images/storage_mapping/dropbox/storage_mapping.png :align: center **Storage Mapping** ``` Once inside a new session, the files will be available at the specified location. ```{figure} /images/storage_mapping/dropbox/files.png :align: center **Personal Dropbox mapped into the container's file system** ``` ### Storage Provider Configuration Examples: - {doc}`Dropbox ` - {doc}`Google Drive ` - {doc}`Nextcloud ` - {doc}`OneDrive ` - {doc}`S3 `