Usage instructions¶

Getting started¶

Launch the product via 1-Click

Use a web browser to access the console application at: http://[ec2-ip]:8080/guacamole where [ec2_ip] is the public ip provided by Amazon for your instance.

Log in using the following credentials:

Username: guacadmin

Password: the instance_id of the instance

You can also access your instance via SSH using the username and your Amazon private key.
The username depends on the operative system:

• Centos 9 Stream: 'ec2-user'
• Other Centos: 'centos'
• Ubuntu: 'ubuntu'
• Rocky Linux: 'rocky'

Installation details¶

Apache Guacamole 1.3.0 is compiled natively and runnning on APache Tomcat 9, with OpenJDK 11 and MySQL 8
The project location is /etc/guacamole ($GUACAMOLE_HOME) where configuration files are stored. The extensions are in $GUACAMOLE_HOME/extensions and the libraries in $GUACAMOLE_HOME/lib
Tomcat server is installed in /usr/java/apache-tomcat-[version] directory, which is linked to /usr/java/apache-tomcat, defined in $CATALINA_HOME.
The Apache Guacamole WAR is deployed at $CATALINA_HOME/webapps.
Services are configured with systemd.
(*) If the client wants to use other kind of authentication, project and libraries are provided at $HOME/software/guacamole directory

Authentication methods¶

MySQL

It uses the authentication module through MySQL database thanks to the library guacamole-auth-jdbc-mysql-x.x.x.jar, in $GUACAMOLE_HOME/extensions directory, the JDBC driver of MySQL, mysql-connector-java-x.x.x.jar, in $GUACAMOLE_HOME/lib directory and the database configuration provided in the file: $GUACAMOLE_HOME/guacamole.properties

PostgreSQL
It uses the authentication module through PostgreSQL database thanks to the library guacamole-auth-jdbc-postgresql-x.x.x.jar, in $GUACAMOLE_HOME/extensions directory, the JDBC driver of PostgreSQL, postgresql-x.x.x.jar, in $GUACAMOLE_HOME/lib directory and the database configuration provided in the file: $GUACAMOLE_HOME/guacamole.properties

Tomcat¶

View status of service:

$ sudo systemctl status tomcat
Stop service:

$ sudo systemctl stop tomcat
Start service:

$ sudo systemctl start tomcat

Guacamole¶

View status of service:

$ sudo systemctl status guacd
Stop service:

$ sudo systemctl stop guacd
Start service:

$ sudo systemctl start guacd

MySQL¶

View status of service:

$ sudo systemctl status mysqld
Stop service:

$ sudo systemctl stop mysqld
Start service:

$ sudo systemctl start mysqld
Access to MysQL console:

$ sudo mysql

PostgreSQL¶

View status of service:

$ sudo systemctl status postgresql
Stop service:

$ sudo systemctl stop postgresql
Start service:

$ sudo systemctl start postgresql
Access to MysQL console:

sudo -u postgres psql

Other useful data¶

Location of sensitive information
There is no sensitive data

Encryption configuration
There is no encrypted data.

Changing system credentials
To change the Guacamole credentials you have to go to the right menu, click "Settings" button, users section, select user guacadmin and complete the form.

Instructions on how the user interacts with Guacamole to decrypt necessary data
You can use the Guacamole management console to view all necessary data.

How to assess and monitor the health and proper function of the application.

1. Navigate to your Amazon EC2 console and verify that you're in the correct region.
2. Choose Instance and select your launched instance.
3. Select the server to display your metadata page and choose the Status checks tab at the bottom of the page to review if your status checks passed or failed.

Additional resources¶

Apache Tomcat: https://tomee.apache.org/
Apache Guacamole: https://guacamole.apache.org
MySQL: https://www.mysql.com/