{{NeedsUpdateMessageBox|backgroundcolor = #faa|image =Warning.png|heading =WARNING|message = This is recommended only for advanced users, proceed with caution.}}= What is Guacamole? = [https://guacamole.incubator.apache.org/ Guacamole] is an HTML5 remote desktop gateway that can be installed on Amahi 9 (Fedora 23). This guidance may work with other Amahi versions with some modification.

== What is Guacamole? == Guacamole is an No browser plugins are needed, and no client software needs to be installed. The client requires nothing more than a web browser supporting HTML5 remote desktop gatewayand AJAX.

Guacamole provides REF: [http://www.tecmint.com/guacamole-access to desktop environments using -remote desktop protocols like VNC and RDP. A centralized server acts as a tunnel and proxy, allowing access to multiple desktops through a -linux-windows-machines-via-web -browser./ Setting Up Web-Based Guacamole Tool to Access Remote Linux/Windows Machines]

No browser plugins = Install Guacamole =<div style="border: 1px solid #A3B1BF; padding: .8em 1em; background-color: #E6F2FF; margin: 0px 1em;">'''WARNING:''' All commands in this tutorial are needed, and no client software needs to be installed. The client requires nothing more than a web browser supporting HTML5 and AJAXexecuted as <code>root</code> (or precede with <code>sudo</code>).</div>

In terminal, as root, We have created a bash script to make installation simple or you can manually install dependencies with using the guidance below. You '''MUST''' complete the [[Guacamole#Create Amahi Web App|Create Amahi Web App]] step prior to executing the following: wget <nowiki>https://www.dropbox.com/s/4hadafih8ahuj2n/install-guacamole.sh</nowiki> chmod 755 install-guacamole.sh ./install-guacamole.sh

For Do NOT use this script on anything less than Amahi 9 / Fedora 21 23 unless you edit it first to match your systems' requirements. (Fedora 23 or newer, substitute <code>dnf</code> for <code>yum</code>See [[Guacamole#Install Dependencies|Install Dependencies]] to learn what changes are necessary.): sudo yum install tomcat gcc cairo-devel libjpeg-devel libpng-devel uuid-devel freerdp-devel pango-devel libssh2-devel libtelnet-devel libvncserver-devel pulseaudio-libs-devel openssl-devel libvorbis-devel libwebp-devel wget

Some packages may be already included in == Create Amahi Web App ==Login to your Amahi Dashboard and installthe Amahi [https://www.amahi. If this is so Fedora org/ Amahi will skip that packageapps/web-apps Web Apps] plug-in. Ensure you '''enable''' [[Advanced Settings]].

* NoteEdit ''####-guacamole.conf'' in '''/etc/httpd/conf.d''' (replacing #### with the appropriate number): vi /etc/httpd/conf.d/####-guacamole.conf Right below the ''ServerAlias'' line, add the following: If ProxyPass / <nowiki>http://localhost:8080/guacamole/</nowiki> ProxyPassReverse / <nowiki>http://localhost:8080/guacamole/</nowiki> Again, if you do not see use vi for creating this file, press the "Webapps" option under "Apps" then you need <i>Esc</i> key to get back in command mode and <i>:wq</i> to activate "Advanced Settings" under write the "Settings" tab of your Amahi dashboardchanges and quit vi.

Restart Apache systemctl restart httpd === Setting up MySQL Authentication =Install Dependencies ====== Creating Due to the Fedora 23 ''freerdp'' packages being unstable, we must use the CentOS stable version. (Do not do this if you are installing on Fedora 21 or below) To install, execute the following:<pre>wget https://www.dropbox.com/s/p2uc1rcpckky75v/libxkbfile-1.0.8-5.el7.x86_64.rpmwget https://www.dropbox.com/s/0tjm7q93z9pw0hj/freerdp-libs-1.0.2-6.el7_2.1.x86_64.rpmwget https://www.dropbox.com/s/aysml7coehz0hqi/freerdp-devel-1.0.2-6.el7_2.1.x86_64.rpmrpm -Uvh libxkbfile-1.0.8-5.el7.x86_64.rpmrpm -Uvh freerdp-libs-1.0.2-6.el7_2.1.x86_64.rpmrpm -Uvh freerdp-devel-1.0.2-6.el7_2.1.x86_64.rpm</pre>  Now install the Fedora dependencies:For Fedora 23 or newer (Fedora 21, substitute <code>yum</code> for <code>dnf</code> and add <code>freerdp-devel</code> to the Database ====list of dependencies): dnf install tomcat gcc cairo-devel libjpeg-devel libpng-devel uuid-devel pango-devel \ libssh2-devel libtelnet-devel libvncserver-devel pulseaudio-libs-devel openssl-devel \ hdalibvorbis-devel libwebp-devel dejavu-sans-mono-createfonts terminus-dbfonts terminus-andfonts-user guacdbconsole

==Configure MySQL Authentication ==== Installing = Install MySQL Authentication Module ====

sudo mkdir -p /var/hda/web-apps/guacamole/sqlauth && cd /var/hda/web-apps/guacamole/sqlauth

sudo wget <nowiki>http://sourceforge.net/projects/guacamole/files/current/extensions/guacamole-auth-jdbc-0.9.9.tar.gz</nowiki>

sudo tar -zxf guacamole-auth-jdbc-0.9.9.tar.gz

sudo wget <nowiki>http://dev.mysql.com/get/Downloads/Connector/j/mysql-connector-java-5.1.38.tar.gz</nowiki>

sudo tar -zxf mysql-connector-java-5.1.38.tar.gz

sudo mkdir -p /usr/share/tomcat/.guacamole/{extensions,lib}

sudo mv guacamole-auth-jdbc-0.9.9/mysql/guacamole-auth-jdbc-mysql-0.9.9.jar /usr/share/tomcat/.guacamole/extensions/ sudo mv mysql-connector-java-5.1.38/mysql-connector-java-5.1.38-bin.jar /usr/share/tomcat/.guacamole/lib/

sudo systemctl restart mariadb.service

=== Create the Database === hda-create-db-and-user guacdb === Loading Guacamole's schema Configure Database Settings ===Create a directory for the configuration file. mkdir -p /etc/guacamole/ Create a file called "guacamole.properties" in that directory vi /etc/guacamole/guacamole.properties Press the <i>i</i> key to begin inserting text into the guacamole.properties file and include the following contents: # MySQL Tables properties mysql-hostname: localhost mysql-port: 3306 mysql-database: guacdb mysql-username: guacdb mysql-password: guacdb # Additional settings mysql-default-max-connections-per-user: 0 mysql-default-max-group-connections-per-user: 0 If you use vi for creating this file, press the <i>Esc</i> key to get back in command mode and <i>:wq</i> to write the changes and quit vi. Now create a symbolic link of this file for Tomcat ln -s /etc/guacamole/guacamole.properties /usr/share/tomcat/.guacamole/ === Load Guacamole Data ===

sudo cat ./*.sql | mysql -u root uroot -p hdaguacdb

::'''WARNING:''' Please see [[Database Root Password]] for the appropriate login password. === Installing Install Guacamole Server ===

sudo wget <nowiki>https://sourceforge.net/projects/guacamole/files/current/source/guacamole-server-0.9.9.tar.gz</nowiki>

sudo ./configure --with-init-dir=/etc/init.d sudo make sudo make install sudo ldconfig

=== Installing Install Guacamole Client ===

sudo mkdir -p /var/lib/guacamole && cd /var/lib/guacamole/

sudo wget <nowiki>http://sourceforge.net/projects/guacamole/files/current/binary/guacamole-0.9.9.war -O guacamole.war</nowiki>

sudo ln -s /var/lib/guacamole/guacamole.war /var/lib/tomcat/webapps/ == Update Amahi Web App Files ==Create Symbolic links between guacamole in Tomcat and Amahi's web app directory ln -s /var/lib/tomcat/webapps/guacamole/* /var/hda/web-apps/guacamole/html Make sure the owner of all the file is ''apache'' and the group is ''users''. chown -R apache:users /var/hda/web-apps/guacamole == Start Guacamole Server ==Restart Tomcat. ​systemctl restart tomcat Start Guacamole Server. /etc/init.d/guacd start Configure Guacamole Server to start at boot. systemctl enable tomcat chkconfig guacd on = Log In to Guacamole =You can access the web login screen for Guacamole from computers in the network via '''<nowiki>http://****:8080/guacamole</nowiki>''' (Where the ''****'' is the IP address of your Amahi server).

The default user name/password is ''guacadmin''/''guacadmin''. You can change your password by editing your own user in the administration screen. =Access Outside the Network == If you want Guacamole's Configuration File web interface to be accessible outside of your LAN you will have to forward a random, unused port (1111, for example) to port 8080 in your router.  Then when you access Guacamole from outside your LAN you will need to add ''/guacamole'' to the end of your url. (<nowiki>http://servername.yourhda.com:1111/guacamole</nowiki>). If you do not add ''/guacamole'' to your url, you will see a blank page since you did not specify which application in Tomcat you wanted to access. The safest and most secure method to access Guacamole is using [https://www.amahi.org/apps/openvpn OpenVPN] and an [[OpenVPN_clients|OpenVPN client]] from a smart phone, tablet, or computer. = Making Preset Connections in Guacamole = In Guacamole, an administrative User can create Connections that will be available to Guacamole users. ==Enabling RDP in Windows Home and Basic Editions =="Remote Desktop Protocol (RDP) is a proprietary protocol developed by Microsoft, which provides a user with a graphical interface to connect to another computer over a network connection." ''1''Create If you do not have Windows pro or ultimate versions you have to run a directory patch that activates RDP. RDP Wrapper Library is an option for enabling RDP features. (Use this at your own risk. Please read RDP Wrapper Library literature and follow directions to install. Any problems are to be addressed with RDP Wrapper Library support.) https://github.com/stascorp/rdpwrap/releases If you have Windows Professional or Ultimate, you will need to "Allow Remote Access to Your Computer." (A simple Internet search of this phrase with your Windows version offers many tutorials on this.) == Guacamole RDP Connections to Windows Computers ==After you have login to Guacamole click on your login name in the upper right . In the drop-down menu choose "Settings." Click on the Connections tab on the settings page. Click the configuration file"New Connection" button.

Create a file called Name: whatever you want to call it (One can put "guacamole.propertiesRDP" within the name so as to differentiate between connections types in that directorythe list){{Code| Code = sudo vi /etc/guacamole/guacamole.properties}} Location: ROOT Protocol: RDP

Press the <i>i</i> key to begin inserting text into the guacamole.properties file and include the following contents: # MySQL properties mysql-hostname: localhost mysql-port: 3306 mysql-database: guacdb mysql-username: guacdb mysql-password: guacdb # Additional settings mysql-default-max-Maximum number of connections-per-user: 02 mysql-default-max-group-Maximum number of connections-per-user: 02

If you use vi for creating this file, press Host Name: The fixed IP address of the <i>Esc</i> key computer to get back in command mode and <i>:wq</i> which you wished to write the changes and quit viconnect. (For example ''192.168.1.10'')

Now create a symbolic link of this file for Tomcat{{Code| Code = sudo ln -s /etc/guacamole/guacamoleAll the other settings are left either blank or as they were.properties /usr/share/tomcat/.guacamole/}}

=== Starting Note: Using RDP, only one device at a time can be logged in under a specific user. If you are logging into a Windows computer by the user "Fred" by RDP using Guacamole Server ===Restart Tomcat, any other device signed in as "Fred" will be logged out. The side effect is that, when using RDP, a technician (using Guacamole) and client (on their Window computer) cannot see the same active desktop simultaneously. As a workaround, one can set up a VNC and an RDP connection for each Windows computer. RDP can be quicker and more fluid so use RDP when working alone and VNC when one needs to see what is currently happening on a Users computer under their account.{{Code| Code = sudo ​service tomcat restart​}}

Start Guacamole ServerSpecial Note: Once settings are in place, users can click on their User Name in the upper right corner and choose "Home" from the drop-down menu to return to the home screen and use pre-configured connections.{{Code| Code = sudo /etc/init.d/guacd start}}

Configure == Guacamole Server VNC Connections to Computers =="In computing, Virtual Network Computing (VNC) is a graphical desktop sharing system that uses the Remote Frame Buffer protocol (RFB) to start at bootremotely control another computer.{{Code| Code = sudo chkconfig tomcat on # chkconfig guacd on}}It transmits the keyboard and mouse events from one computer to another, relaying the graphical screen updates back in the other direction, over a network."''2''

== Configuring In order to connect through Guacamole to a client device by VNC, one needs to install VNC client software on the device and Amahi ==Create Symbolic links between guacamole in Tomcat and Amahiconfigure it to the user's webapp directorydesired specifications. In this publication, we will use a Windows based client and UltraVNC software, though this is by no means prescriptive for everyone.

{{Code| Code = sudo ln -s /var/lib/tomcat/webapps/guacamole/* /var/hda/web==Guacamole VNC Connections to Windows Computers =======UltraVNC Settings for Windows====Be sure to install UltraVNC to run as a service on the client system. Once UltraVNC is installed on the Windows computer, right-apps/guacamole/html}}click on the system tray icon and choose "Admin Properties" from the menu that comes up. Set the following values:

As root Display Number or Ports to use: Select Ports and set Main and Http so something specific (e.g. 5904, create .htaccess file in /var/hda/web-apps/guacamole/html{{Code|5804)Code = vi /var/hda/webAuthentication: Set both the VNC Password and the View-apps/guacamole/html/Only Password.htaccess}} (Write them down. You will need it later.)

Press Click "OK" and then give permission for the <i>i</i> key program to begin inserting text into the .htaccess file and include the following: RewriteEngine On RewriteCond %{SERVER_PORT} 80 RewriteRule (make changes to your system.*) <nowiki>http://%{HTTP_HOST}:8080/guacamole</nowiki> [R,L]

Again, if you use vi for creating this file, press ====Guacamole Settings to Connect to the <i>Esc</i> key Windows client====After logging in to get back Guacamole click on your login name in command mode and <i>:wq</i> to write the changes and quit viupper right . In the drop-down menu choose "Settings." Click on the Connections tab on the settings page. Click the "New Connection" button.

Make sure the owner of all the file is apache and the group is users.{{Code|Code = sudo chown -R apacheBelow are some VERY basic settings for a VNC connection in Guacamole:users /var/hda/web-apps/guacamole}}

== Logging In Host Name: The fixed IP address of the computer to which you wished to Guacamole ==connect. (For example ''192.168.1.10'')You can access Port: The Main port number which was set in the web login screen for Guacamole from Windows UltraVNC client software (e.g. 5904). Password: The VNC Password set earlier in the server at <nowiki>http://localhost:8080/guacamole</nowiki>Windows UltraVNC client software.

From All the other computers in the network you can access Guacamole by <nowiki>http://****:8080/guacamole</nowiki> (Where the "****" is the ip address of your Amahi server)settings are left either blank or as they were.

The default user is "guacadmin"Special Note: Once settings are in place, with users can click on their User Name in the default password of upper right corner and choose "guacadminHome". You can change your password by editing your own user in from the drop-down menu to return to the administration home screenand use pre-configured connections.

With everything configured correctly you should be able to access the web login screen through Amahi at <nowiki>http== References ==''1'' https://guacamoleen.yourhdanamewikipedia.com:8080/guacamoleorg/<wiki/nowiki>Remote_Desktop_Protocol

== Port Forwarding ==If you want Guacamole's web interface to be accessible outside of your LAN you will have to forward a random'2'' Richardson, T.; Stafford-Fraser, Q.; Wood, K. R.; Hopper, unused port A. (1111, for example1998) to port 8080 in your router. Then when you access Guacamole from outside your LAN you will need to add "/guacamoleVirtual network computing" to the end of your url(PDF). (serverblahblahIEEE Internet Computing.yourhda2: 33.comdoi:111110.1109/guacamole) If you do not add "/guacamole" to your url, you will see a blank page since you did not specify which application in Tomcat you wanted to access4236.656066.