Changes for page Using Guacamole in HDC

Last modified by Dennis Segebarth on 2024/08/16 08:54
From version 19.1
edited by Dennis Segebarth
on 2024/08/16 08:23
Change comment: There is no comment for this version
To version 8.1
edited by Dennis Segebarth
on 2023/09/13 17:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -7,7 +7,7 @@
7 7  Apache Guacamole is a clientless remote desktop gateway that gives you access to Project-based Virtual Machines (VMs) to perform computational analyses on your Project data. Guacamole supports standard protocols like VNC, RDP, and SSH. To learn more about the application, visit the [[Guacamole documentation>>https://guacamole.apache.org/]] and [[administration guide>>https://guacamole.apache.org/doc/gug/administration.html]].
8 8  
9 9  (% class="wikigeneratedid" %)
10 -[[image:1723655513077-695.png||height="155" width="399"]]
10 +[[image:Guacamole-Logo-300x100px cropped.png||data-xwiki-image-style-alignment="center" height="146" width="376"]]
11 11  
12 12  = How it works =
13 13  
... ... @@ -17,7 +17,6 @@
17 17  
18 18  * Project Collaborator role or higher.
19 19  * Guacamole application and connected virtual machines pre-configured for the Project by the Platform Administrator. See //Getting Access to Guacamole//.
20 -* Workspace VM-specific credentials to login at VM(s). See //Management of Workspace VM-specific credentials//.
21 21  
22 22  = Data Stewardship =
23 23  
... ... @@ -25,7 +25,7 @@
25 25  
26 26  = Getting Access to Guacamole =
27 27  
28 -[[image:1723655536338-430.png||height="191" width="343"]]
27 +[[image:Project Workspace tool navigation Guacamole v2.1.5 2023-01-23.png||height="179" width="322"]]
29 29  
30 30  1. (((
31 31  Launch your Project and click **Guacamole **in the workspace icon group.
... ... @@ -34,64 +34,10 @@
34 34  1. After the Platform Administrator has deployed Guacamole as a workspace tool for your Project, you can request access to the Guacamole-connected VMs. Every project member must complete this step to initialize their identity in the Guacamole system.
35 35  )))
36 36  1. In the pop-up window, enter a message to the Project Administrator containing the details of your access request, then click **Send Request**.
37 -1. A message confirms the request has been sent. Project Administrators receive a notification about your request in the portal notification system.
36 +1. A message confirms the request has been sent. Project Administrators receive a notification by email and in the portal notification system.
38 38  
39 -After the Project Administrator receives the notification and sets up the requested access to the Guacamole-connected VM(s), you can use Workspace VM(s) via Guacamole with your Workspace VM-specific credentials (see //Management of Workspace VM-specific credentials//).
38 +After the Project Administrator receives the notification and sets up the requested access to the Guacamole-connected VM(s), you will receive credentials that you can use to log into VMs and you can begin using Guacamole.
40 40  
41 -= Management of Workspace VM-specific credentials =
42 -
43 -Login to Workspace VMs via Guacamole requires your Workspace VM-specific credentials, i.e. username and password:
44 -
45 -* Username: Your EBRAINS username
46 -* Password: A password specific for login on Workspace VMs within the HDC (see //Workspace VM-specific password//)
47 -
48 -**Please note: **The scope of your Workspace VM-specific credentials is platform-wide, i.e. they are valid for all VMs within the HDC to which you have access.
49 -
50 -== Workspace VM-specific password ==
51 -
52 -You can create, change, and reset your Workspace VM-specific password via the HDC platform.
53 -
54 -=== Create or Reset your Workspace VM-specific password ===
55 -
56 -For the initial creation of your Workspace VM-specific password, or to reset it at any time:
57 -
58 -1. Open your **Account **page in the HDC platform.
59 -1. Depending on whether you are generating your Workspace VM-specific password for the first time, or are resetting it after initial creation, click on the **Generate VM Password** or **Reset VM Password** button, respectively (see below, which shows the **Reset VM Password** button). Please note: This button will be disabled for your account until a Project Admin approved your Guacamole access request.
60 -[[image:Reset_workspace_vm_password_01.png||height="154" width="861"]]
61 -1. A pop-up window will prompt you to confirm the generation or reset of your VM-specific password:
62 -11. Click on **Cancel** to abort the process.
63 -11. Click on **Generate VM Password **or **Reset VM Password**, respectively, to confirm the action
64 -[[image:Reset_workspace_vm_password_02.png||height="181" width="409"]]
65 -1. Once you confirmed the action, a new pop-up window will open and display your new Workspace VM-specific password to you. **Please make sure to save it appropriately, as you won´t be able to view it again once you close this pop-up window. **This randomly created password consists of lower case letters only. You will also receive a notification via email that your Workspace VM-specific password has been reset.  
66 -[[image:Reset_workspace_vm_password_03.png||height="198" width="449"]]
67 -1. You can now use this password to login to all Guacamole Workspace VMs you have access to within the HDC platform. We highly recommend changing it after your first login, see //Change your Workspace VM-specific password** **//below for more information.
68 -
69 -=== Change your Workspace VM-specific password ===
70 -
71 -In order to change your Workspace VM-specific password, please login to a Workspace VM (see //Launching a Guacamole VM connection//, and //Establishing a Desktop VM Connection// or //Establishing a Command Line VM Connection//, respectively).
72 -
73 -a) Change your VM-specific password via a Desktop VM Connection:
74 -
75 -1. After logging in to a Desktop VM using your current Workspace VM-specific credentials, open the **Settings** application.
76 -1. One the left-hand menu click on **Users**.
77 -1. Make sure your account is selected and then click in the **Password** field in the "Authentication & Login" section.
78 -1. A pop-up will open and prompt you to confirm this action by providing your current password (i.e. your current Workspace VM-specific password), and to specify the new one. The new password must be at least 8 characters long.
79 -1. Confirm to change your password by clicking on **Change**.
80 -
81 -[[image:1723796357125-338.png||height="254" width="459"]]
82 -
83 -b) Change your VM-specific password via a Command Line VM Connection:
84 -
85 -1. After logging in to a Command Line VM using your current Workspace VM-specific credentials, enter the command //passwd//
86 -1. You are now prompted to provide your current Workspace VM-specific password.
87 -1. Next, you are prompted to provide your new password. The new password must be at least 8 characters long.
88 -1. You are prompted to confirm the new password by providing it again.
89 -1. A message in the terminal will notify you about the successful update of your password.
90 -
91 -[[image:1723796579348-927.png||height="128" width="464"]]
92 -
93 -After you changed your Workspace VM-specific password, the new password will be valid for all Workspace VMs within the HDC that you have access to.
94 -
95 95  = Launching a Guacamole VM Connection =
96 96  
97 97  After the first-time setup has been completed, you can start using Guacamole to access your Project Virtual Machines (VMs). Both Desktop and Command Line Interface VM connections are possible, depending on which VMs have been deployed for the Project and which VMs you have access to.
... ... @@ -102,7 +102,8 @@
102 102  (% start="1" style="list-style-type:lower-alpha" %)
103 103  1. If you have access to **both** Desktop **and **Command Line Interface VM connections, the Connections screen lists the available VMs. Each VM connection is identified by a name and ID number indicating
104 104  whether it is a Desktop or Command Line connection. Click a **VM connection **to initiate it.
105 -\\[[image:1723655596724-237.png||height="186" width="793"]]
50 +\\[[image:HDC Guacamole VMs from XWiki.png]]
51 +
106 106  1. If you only have access to **either** a Desktop connection **or **a Command Line Interface connection, the relevant login screen (Desktop or Command Line Interface) appears.
107 107  )))
108 108  1. Follow the instructions for establishing a **Desktop** or **Command Line Interface** VM connection.
... ... @@ -109,17 +109,17 @@
109 109  
110 110  == Establishing a Desktop VM Connection ==
111 111  
112 -[[image:1723655606316-749.png||height="426" width="365"]]
58 +[[image:Guacamole login modal from XWiki 2023-01-23.png||height="285" width="244"]]
113 113  
114 -1. On the Desktop login screen, enter your VM-specific credentials (see //Management of Workspace VM-specific credentials//), then click **OK. **
60 +1. On the Desktop login screen, enter your VM-specific username and password, which were provided to you by the Platform Administrator, then click **OK. **
115 115  1. The VM connection is established.
116 116  1. After connecting, you can begin working in your Desktop VM. To launch a Linux terminal, see //Launching a Linux Terminal inside a Desktop VM//.
117 117  
118 -//Note: //We recommend to change your VM-specific password upon first login to the VM. See //Change your Workspace VM-specific password//.
64 +//Note: //We recommend to change your VM-specific password upon first login to the VM. For this, type {{code language="none"}}passwd{{/code}} in a Linux terminal inside the VM, hit return on your keyboard and follow the instructions to change your password. Please make sure to save the new password in a secure location.
119 119  
120 120  == Establishing a Command Line VM connection ==
121 121  
122 -[[image:1723655625737-284.png||height="56" width="466"]]
68 +[[image:Project Workspace Guacamole CLI Connection Login v2.1.5 2023-02-06.png||height="68" width="566"]]
123 123  
124 124  {{code language="none" width="50%"}}
125 125  Welcome to Ubuntu 20.04.5 LTS (GNU/Linux 5.15.0-1019-azure x86_64)
... ... @@ -129,16 +129,16 @@
129 129   * Support: https://ubuntu.com/advantage
130 130  {{/code}}
131 131  
132 -1. On the Command Line login screen, enter your VM-specific credentials (see //Management of Workspace VM-specific credentials//), .
78 +1. On the Command Line login screen, enter your VM-specific username and password, which were provided to you by the Platform Administrator.
133 133  1. The VM connection is established.
134 134  
135 -//Note: //We recommend to change your VM-specific password upon first login to the VM. See //Change your Workspace VM-specific password//.
81 +//Note: //We recommend to change your VM-specific password upon first login to the VM. For this, type {{code language="none"}}passwd{{/code}} in the Command Line VM, hit return on your keyboard and follow the instructions to change your password. Please make sure to save the new password in a secure location.
136 136  
137 137  == Launching a Linux Terminal inside a Desktop VM ==
138 138  
139 139  After successfully logging into a Desktop VM, the default desktop is displayed. To launch the pre-installed Linux applications such as a standard terminal,
140 140  
141 -[[image:1723655669214-227.png||height="481" width="864"]]
87 +[[image:Project Workspace Guacamole Desktop Linux Terminal v2.1.5 2023-02-06 1422.png||height="446" width="802"]]
142 142  
143 143  1. Click **Activities **in the upper left corner.
144 144  1. Enter {{code language="none"}}terminal{{/code}} in the search box.
... ... @@ -153,10 +153,13 @@
153 153  |(% style="width:236px" %)(((
154 154  File upload to indicated zone
155 155  )))|(% style="width:196px" %)Yes|(% style="width:255px" %)Yes
156 -|(% style="width:236px" %)File download from indicated zone|(% style="width:196px" %)No|(% style="width:255px" %)Yes
102 +|(% style="width:236px" %)File download to indicated zone|(% style="width:196px" %)NO|(% style="width:255px" %)Yes
157 157  
104 +
158 158  ----
159 159  
160 -Copyright © 2023-2024 [[Indoc Systems>>url:https://www.indocsystems.com]].
107 +Copyright © 2023 [[Indoc Systems>>url:https://www.indocsystems.com]].
161 161  
162 162  HealthDataCloud is powered by Pilot technology, a product of [[Indoc Systems>>url:https://www.indocsystems.com]].
110 +
111 +
1714664556786-681.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -19.5 KB
Content
1714664820303-772.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -13.9 KB
Content
1714664883045-227.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -13.8 KB
Content
1714665571979-332.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -95.2 KB
Content
1715680543371-142.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -87.4 KB
Content
1715680596889-912.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -87.8 KB
Content
1723655513077-695.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -10.9 KB
Content
1723655536338-430.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -69.9 KB
Content
1723655596724-237.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -58.9 KB
Content
1723655606316-749.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -169.1 KB
Content
1723655625737-284.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -1.9 KB
Content
1723655669214-227.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -220.4 KB
Content
1723796357125-338.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -83.0 KB
Content
1723796579348-927.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -26.2 KB
Content
Reset_workspace_vm_password_01.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -233.9 KB
Content
Reset_workspace_vm_password_02.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -183.8 KB
Content
Reset_workspace_vm_password_03.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -178.0 KB
Content
Untitled-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.dsegebarth
Size
... ... @@ -1,1 +1,0 @@
1 -165.5 KB
Content