User Guide

Welcome to VM Lab! This guide will help you get started with managing your virtual machines (VMs), users, and bookmarks through the web interface.

Table of Contents

• Table of Contents
• Logging-in and registration
  • Register
  • Login
  • Waiting list
• Dashboard overview
• Managing Virtual Machines (VMs)
  • Add a VM
  • Edit a VM
  • Delete a VM
  • Assign a VM
  • Connect to a VM
• Managing bookmarks
• User settings
  • Change username
  • Change email
  • Change password
  • Change name and surname
• User management (Admins/Managers)
  • Approve or deny New Users
    • Edit user roles
  • Disable, re-enable, or delete users

Logging-in and registration

Register

Click on the "Register" link in the sidebar. Fill in your details and submit.

Login

Use your username and password to login.

Waiting list

After registering, your account will be added to a waiting list. You will not be able to access the platform until an admin or manager reviews and approves your registration.

Dashboard overview

After being approved and logging in, you will see your dashboard. The sidebar menu adapts to your role (Admin, Manager, Sidekick, Regular User) and provides access to:

• My VMs: List and manage your owned VMs.
• Assigned VMs: (If applicable) VMs assigned to you.
• Bookmarks: Manage your bookmarks.
• User Settings: Change your account details.
• User Management: (Admins/Managers only) Manage users and waiting list.

Managing Virtual Machines (VMs)

Add a VM

1. Go to "My VMs".
2. Click "Add VM".
3. Fill in the VM details (name, host, port, username, password/SSH key).
4. Click "Save".

Edit a VM

1. In the VM list, click "Edit" next to the VM.
2. Update the details as needed.
3. Click "Edit" to save changes.

Delete a VM

1. In the VM list, click "Delete" next to the VM.
2. Confirm the deletion in the dialog.

Assign a VM

(Admins/Managers only)

1. Go to "Assigned VMs".
2. Click "Assign a new VM".
3. Select the user and fill in VM details.
4. Click "Save".

Connect to a VM

1. In the VM list, click "Connect".
2. If no authentication method has been saved, input the password.
3. You will be moved to the page with the terminal and file explorer.

Managing bookmarks

1. Go to "Bookmarks" in your dashboard.
2. Click "Add Bookmark" to add a new one (the link must start with www to be an actual link).
3. Edit or delete bookmarks using the corresponding buttons.
4. Open the bookmark by clicking on the link.

User settings

Change username

Go to "User Settings" and use the "Change Username" form.

Warning

You will be logged out after changing your username.

Change email

Use the "Change Email" form in "User Settings".

Change password

1. Use the "Change Password" form.

2. Enter your current password and the new password twice.

Change name and surname

Use the "Change Name and Surname" form. You can change either or both fields.

User management (Admins/Managers)

Approve or deny New Users

1. Go to "Manage Waiting List".
2. Click "Accept" or "Deny" for each user.
3. Assign a role when accepting.

Edit user roles

1. Go to "Manage Users".
2. Click "View" on a user, then use the role change form.

Disable, re-enable, or delete users

1. In the user details page, use the "Disable User", "Revert Disabling", or "Delete User" buttons.
2. Disabling a user shares all their VMs; deleting removes the user and their VMs.