Guacamole - XWiki

Apache Guacamole is a clientless remote desktop gateway that supports standard protocols like VNC, RDP, and SSH. Guacamole has been integrated into the VRE using a Single Sign-On Protocol and is configured on a per-project basis by a System Administrator so that each project has its own deployment of Guacamole and an assigned Guacamole Administrator.

2

3

Project Administrators may contact the Platform Administrator at __[[vre-support@charite.de>>path:mailto:vre-support@charite.de]]__ to set up Guacamole for their project. Additional information can be found at __[[https:~~/~~/guacamole.apache.org/doc/gug/administration.html>>url:https://guacamole.apache.org/doc/gug/administration.html]]__.

4

5

Users are reminded that the VRE Platform Terms of Use __prohibit any code or files containing personal information of data subjects__ from entering the VRE, including workbench tools unless it has first been uploaded to the Green Room and [[approved by the Project Administrator>>doc:Main.user_guide.Managing User Accounts.WebHome]] for use in the VRE Core.

6

7

== Requesting access to Guacamole ==

8

9

Once Guacamole has been deployed as a workbench tool for a new Project, Project members can request permission to access that Project's instance of Guacamole by clicking on the Guacamole icon in the left sidebar of the Project landing page.

10

11

[[image:1622123615332-666.png]]

12

13

A prompt will appear to send the request, once the user clicks send, the System Administrator for the Project will receive an email notification and a portal notification. The System Administrator can then set up the user's access control from the //Users// tab in the Project's Guacamole Settings page, and grant user access to individual Virtual Machines (VM) connected through Guacamole.

14

15

Once permission has been set up, the System Administrator can then mark the request as "Complete" in the User Management tab of the VRE Portal. The user will be automatically notified by email that the setup is complete and their access to Guacamole has been granted.

16

17

Project members will then be able to launch and enter the Project-based Guacamole workbench and access the Virtual Machines that they been granted connection permissions for.

18

19

20

== Accessing Virtual Machines through Guacamole ==

21

22

To access a Virtual Machine through Guacamole, follow the steps below:

23

24

1. Navigate to the Project landing page and click on the Guacamole icon in the Left Sidebar.

25

1. Click the name of the VM connection that made available to you.

26

1. Enter your VRE user credentials and click **OK. **

27

1. The Virtual Machine will connect automatically.

28

29

[[image:1633094937486-603.png]]

30

31

=== 1. Desktop VM connection ===

32

33

==== a. Login to the VM ====

34

35

(% class="wikigeneratedid" %)

36

If you select the **Core-Desktop**-<ID> or **Greenroom-Desktop**-<ID> VM to connect for either **Core** or **Greenroom**, a login modal will pop up to ask for your VRE user credential when you enter the VM as following screenshot:

37

38

(% class="wikigeneratedid" %)

39

[[image:1633095087839-197.png]]

40

41

== [[image:VM login.png]] ==

42

43

==== b. Launch Linux Terminal inside the Desktop VMs ====

44

45

After the successful login, users will see the default desktop (XFCE4). To launch the pre-installed Linux applications such as standard terminal, please try the following two steps:

46

47

1. Click the "Activities" on the left upside corner.

48

1. Type "Terminal" in the search box.

49

50

[[image:VM activities.png]]

51

52

[[image:VM terminal.png]]

53

54

55

=== 2. Command Line VM connection ===

56

57

==== a. Login to the VM ====

58

59

If you prefer to login as command line directly without GUI, you can select **Core-CommandLine**-<ID> or **Greenroom-CommandLine**-<ID> for this need, and then provide VRE credential to login.

60

61

[[image:1633095235660-603.png]]

62

63

[[image:1633095282954-874.png]]

64

65

=== 3. Greenroom and Core VM connection ===

66

67

VRE Command Line Tool is deployed within each of the Workbench VM as extension resource. The VRE CLI will carry different file operation permissions within Greenroom-VM or Core-VM, which is the only difference between Greenroom-VM and Core-VM.

68

69

For detailed file operation permission differences, please find [[File Operation Permission Control in VRE CLI>>url:https://vre.charite.de/xwiki/wiki/adminsubwiki/view/Main/user_guide/Common%20Workflows/2%20Upload%20data%20back%20to%20project%20in%20Workbench%20tool%20using%20VRE%20Command%20Line%20Tool/2.1%20File%20Operation%20Permission%20Control%20in%20VRE%20CLI%20/]]

----

**See Also: **

[[User Roles>>doc:Main.user_guide.Managing User Accounts.User Roles.WebHome]]

76

77

[[Platform Architecture>>doc:Main.user_guide.About the VRE.Introduction]]

78

79

[[JupyterHub>>doc:Main.user_guide.Analyzing Data.JupyterHub.WebHome]]

----

(% style="text-align:center" %)

85

image:https://i.creativecommons.org/l/by-sa/4.0/88x31.png

86

87

(% style="text-align: center;" %)

88

Copyright © 2022, Indoc Research. This work is licensed under a [[Creative Commons Attribution-ShareAlike 4.0>>http://creativecommons.org/licenses/by-sa/4.0/ ||rel="noopener noreferrer" target="blank"]] International License.

89

Wiki source code of Guacamole