https://github.com/bmarwell/guacamole-ibmliberty
An example of how to run Apache Guacamole on IBM Liberty Profile
https://github.com/bmarwell/guacamole-ibmliberty
docker-compose java openliberty vnc vnc-server
Last synced: 2 months ago
JSON representation
An example of how to run Apache Guacamole on IBM Liberty Profile
- Host: GitHub
- URL: https://github.com/bmarwell/guacamole-ibmliberty
- Owner: bmarwell
- License: apache-2.0
- Created: 2017-11-27T08:49:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-28T08:33:54.000Z (over 8 years ago)
- Last Synced: 2025-04-02T01:11:09.313Z (over 1 year ago)
- Topics: docker-compose, java, openliberty, vnc, vnc-server
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Guacamole on liberty profile
This github repository shows how to create guacamole on a liberty profile
server. The default container uses jetty or tomcat as application server.
As IBM open sources liberty profile on
[ Open Liberty](https://openliberty.io/),
I found it suitable to create an
example on how to use guacamole on IBM liberty profile.
## Setup instructions
1. Edit docker-compose.yml Set the traefik hostname in your label, if needed.
1. create a file `./user-mapping.xml`.
1. run: `docker-compose up --build -d` to start the service.
1. use the selected domain to connect or use `docker ps` to find the ip and
port.
## Customization
### Exposing the port to the public internet
The `docker-compose.yml` is pre-configured for use with
[ træfik](https://traefik.io/).
Just create a local branch and change the
hostname and URL to a domain which points to your public træfik host.
You may also want to change the name of the external network, which might have
a different name (like traefik\_websocket or sth.).
### Adding plug-ins
Modify the `./guacamole-web/Dockerfile` to download additional plugins.
## Debugging
### Guacamole
Guacamole uses slf4j as logging API and logback as its implementation. To
configure logging, just point to a customized logback.xml file using the jvm
option `-Dlogback.configurationFile=`.
The original logback.xml file can be found
[at :octocat: apache/incubator-guacamole-client/…/logback.xml](https://raw.githubusercontent.com/apache/incubator-guacamole-client/master/guacamole/src/main/resources/logback.xml).
### IBM J9 Virtual Machine
All JVM arguments can be added to the file `./guacamole-web/jvm.options`. You
will need a new build afterwards (or just mount the changed file as a volume).
IBM‘s Java J9 Runtime (here: version 8) allows a lot of customization and
dumping options. The documentation is excellent and can be found here:
[:link: Using -Xdump options](https://www.ibm.com/support/knowledgecenter/en/SSYKE2_8.0.0/com.ibm.java.lnx.80.doc/diag/tools/dumpagents_syntax.html).
You can force up to three heap dumps by executing a `kill -9` to the liberty
java process, and it is possible to create heapdumps at certain events.
Also, by default FFDC (First Failure Data Capture) files are written on the
first occurence of an uncaught java exception. They can be found in the
directory `/config/logs/ffdc` and provide a lot of useful information, like a
stack trace and loaded libraries. More information on this topic can be found
here: [:link: Liberty Profile Logging](https://www.ibm.com/support/knowledgecenter/en/SSEQTP_8.5.5/com.ibm.websphere.wlp.doc/ae/rwlp_logging.html).
## Source Code of OSS products
### Guacamole and guacd
* Client (war file): [:octocat: apache/incubator-guacamole-client](https://github.com/apache/incubator-guacamole-client).
* Server (guacd): [:octocat: apache/incubator-guacamole-server](https://github.com/apache/incubator-guacamole-server).
### IBM J9 JRE and open liberty application server
* Open Liberty: [:octocat: OpenLiberty](https://github.com/OpenLiberty).
* IBM J9 JRE v1.8 is not open sourced.
* The upcoming Eclipse J9 JRE v9 is open source: [:octocat: Eclipse/openj9](https://github.com/eclipse/openj9).
[openlibertyiofav]: https://openliberty.io/favicon.ico
[traefikiofav]: https://traefik.io/favicon.ico