User Profile

You will find the user profile in the top right corner of the navigation bar.

SSH Key Setup

Users that want to interact with version control systems like GitHub or GitLab, can use the SSH Key setup in their profile. Setting up SSH Keys in the user profile will create a working .gitconfig on each assembly automatically once a session starts. The created .gitconfig can be customized as described in section .gitconfig-Templating

For SSH Key setup to work properly, users must create a personal access token in their version control system that has permissions to setup public keys in the user profile. In case of GitLab this corresponds to setting the api scope for the access token. For GitHub, a personal access token with admin:public_key scope is required.

Personal Tokens for SSH Key Setup

In contrast to Version Control Access for veHaaS access tokens it is necessary to use a personal access token here.

.gitconfig-templating

To work with external customer the default .gitconfig does not work, due to self-signed certificates, ... Therefore we introduced a feature to add the possibility to template the .gitconfig. If no template is available, veHaaS will use the internal default one, which corresponds to:

[user]
    name = __NAME__
    email = __EMAIL__

If you need to customize it create a file called .gitconfig_default. The content should be the same as the default template, but can be extended however you like. Please do not mess with ssh-key settings, and rely on the SSH Key Setup

User Cleanup Paths

To clean up and delete paths from the VM after your sessions you can add them to the User cleanup paths. The user cleanup paths page is located on the user profile page under the User Cleanup Paths tab.

Cleanup Paths

There are default paths that are always deleted after a session. You can add additional paths that should be cleaned up. It is possible to include directories or files.

Paths can be added with the Add Path button and you can delete paths by clicking the bin icon on the right. Default paths can not be removed from cleanup.

Cleanup paths should be used with care!

Files will be deleted permanently on the virtual machine and other users will be affected by your actions.

Exclude Paths

It is also possible to exclude paths from the cleanup. This can be useful if you want to delete a folder, but want to keep some files of it. If you exclude a folder from cleanup the sub folders will not be excluded automatically too.

Example

• FolderA
  • FolderA1
    • File1
    • File2
  • File3
  • File4
• FolderB

---

Cleanup: "FolderA"

Exclude: "FolderA/FolderA1"

---

Result:

• FolderA

  • FolderA1

• FolderB

User Mount Path

The user mount path page is located on the user profile page under the User Mount Path tab. The user mount path page allows the user to view, add and delete paths that are mounted when the user logs into a virtual machine.

Functionality

1. View Mount Paths: The user mount path page displays a list of all mount paths that are mounted when the user logs into a virtual machine.
2. Create a new mount path: To create a new mount path, click on the Add button. A modal will open where the user can select a drive that should be mounted upon connecting to a virtual machine.
3. Delete a mount path: To delete a mount path, click on the button next to the mount path that should be deleted.

Tutorial

Environment variables

The environment variables view allows you to define custom variables that are automatically set at the beginning of a session on the virtual machine (VM). These variables are particularly useful for configuring the environment to meet the specific requirements of your application, such as setting paths, credentials, or other runtime configurations.

At the end of the session, all environment variables are automatically unset during cleanup to ensure no residual configurations persist on the VM, guaranteeing a clean and secure environment for subsequent sessions.

The environment variables defined here are tied to your personal user profile and are only available in sessions initiated by you. If you are working with organization-level or group-level tokens, you can configure environment variables as described in the Access-Tokens-Environment-Variables section. This ensures flexibility and consistency when managing environment configurations across different contexts.

Create an environment variable

Open the Create Dialog:

• To create a new environment variable, click on the ADD button. This will open the environment variable creation dialog.

Define the Variable:

• In the dialog, you can define the name and value of the environment variable. Ensure that the name is unique and descriptive to avoid conflicts or confusion.
• The value can include paths, credentials, or any configuration data required for your application.
• Once the name and value are defined, click on the ADD button at the bottom right of the dialog to save the variable.

Open the Create DialogDefine the Variable

Edit an Environment Variable

Open the Edit Dialog:

• To edit an existing environment variable, click on the icon next to the variable you want to modify. This will open the edit dialog.

Modify the Value:

• In the edit dialog, you can update the value of the environment variable. For example, you can change a file path, update credentials, or adjust runtime configurations.

• Once you’ve made the necessary changes, click on the ADD button at the bottom right to save the updated variable.

• If you need to change the name of the variable, you must delete the existing variable and create a new one with the desired name. Name changes cannot be made directly in the edit dialog.

Open the Edit DialogModify the Value

Delete an Environment Variable

Open the Delete Dialog:

• To delete an environment variable, click on the icon next to the variable you want to remove. This will open the delete confirmation dialog.

Confirm the Deletion:

• In the delete dialog, confirm that you want to delete the variable by clicking the DELETE button at the bottom right. Be cautious, as this action cannot be undone.

Open the Delete DialogConfirm the Deletion