A Jakarta EE 10 web application for searching a software inventory spanning multiple repos, relying on the Smoothness web lib.
A web app for managing a registry of software for the Accelerator Controls Group (ACG) at JLab.
- Grab project
git clone https://github.com/JeffersonLab/sim
cd sim
- Launch Compose
docker compose up
- Navigate to page
http://localhost:8080/sim
Note: Login with demo username "tbrown" and password "password".
Note: The app container starts once Oracle has loaded the schema and Keycloak has created the test realm and users, about a minute after docker compose up.
The containers publish these ports on the host, listening only on its local address (127.0.0.1), so other computers can't reach the test database, accounts, and management consoles. To use them from another computer, forward them over SSH, such as ssh -N -L 8443:localhost:8443 -L 8081:localhost:8081 <host> for the app and Keycloak. If another project already uses some of them, or you run a second copy of the app, set other ports in a .env file next to compose.yaml, which Compose reads, or in the environment:
| Variable | Default | Port of |
|---|---|---|
| SIM_HTTPS_PORT | 8443 | sim (HTTPS) |
| SIM_HTTP_PORT | 8080 | sim (HTTP) |
| SIM_MANAGEMENT_PORT | 9990 | Wildfly management |
| SIM_KEYCLOAK_PORT | 8081 | Keycloak |
| SIM_KEYCLOAK_MANAGEMENT_PORT | 9991 | Keycloak management |
| SIM_ORACLE_PORT | 1521 | Oracle |
| SIM_ORACLE_EM_PORT | 5500 | Oracle Enterprise Manager |
| SIM_PUPPET_PORT | 3000 | Puppet Show |
| SIM_SMTP_PORT | 1025 | MailHog SMTP |
| SIM_MAILHOG_PORT | 8025 | MailHog web UI |
Keycloak's login redirects and the app's links follow SIM_KEYCLOAK_PORT and SIM_HTTPS_PORT, and Wildfly listens for HTTPS on SIM_HTTPS_PORT inside the container too, so its redirects from HTTP to HTTPS reach it. Compose names the containers, network, and images after the project's directory, such as sim-oracle-1, so a copy in another directory, such as a git worktree, gets its own.
This application requires a Java 17+ JVM and standard library to run, plus a Jakarta EE 10 application server (developed with Wildfly).
- Install service dependencies
- Download Wildfly 37.0.1
- Configure Wildfly and start it
- Download sim.war and deploy it to Wildfly
- Navigate your web browser to localhost:8080/sim
Wildfly must be pre-configured before the first deployment of the app. The wildfly bash scripts can be used to accomplish this. See the Dockerfile for an example.
Uses the Smoothness Environment Variables.
This application requires an Oracle 19+ database with the following schema installed. A release that changes the schema comes with a script for existing databases in container/oracle/upgrade, named for the release; the release notes say when one is needed. The application server hosting this app must also be configured with a JNDI datasource.
This project is built with Java 21 (compiled to Java 17 bytecode), and uses the Gradle 9 build tool to automatically download dependencies and build the project from source:
git clone https://github.com/JeffersonLab/sim
cd sim
gradlew build
Note: If you do not already have Gradle installed, it will be installed automatically by the wrapper script included in the source
Note for JLab On-Site Users: Jefferson Lab has an intercepting proxy
See: Docker Development Quick Reference
In order to iterate rapidly when making changes it's often useful to run the app directly on the local workstation, perhaps leveraging an IDE. In this scenario run the service dependencies with:
docker compose -f deps.yaml up
Note: The local install of Wildfly should be configured to proxy connections to services via localhost and therefore the environment variables should contain:
KEYCLOAK_BACKEND_SERVER_URL=http://localhost:8081
FRONTEND_SERVER_URL=https://localhost:8443
Further, the local DataSource must also leverage localhost port forwarding so the standalone.xml connection-url field should be: jdbc:oracle:thin:@//localhost:1521/xepdb1.
The server and app setup scripts can be used to setup a local instance of Wildfly.
Unit tests run with the build (gradlew build, or gradlew test alone). Integration tests send requests to a running app and its services, and log in as the test accounts, so start them first with docker compose -f build.yaml up -d --build --wait, then run:
gradlew integrationTest
If the stack runs on other ports (see Ports), point the tests at them with SIM_URL (such as https://localhost:48443/sim) and KEYCLOAK_URL (such as http://localhost:48081/auth).
- Bump the version number in the VERSION file and commit and push to GitHub (using Semantic Versioning).
- The CD GitHub Action should run automatically invoking:
- The Create release GitHub Action to tag the source and create release notes summarizing any pull requests. Edit the release notes to add any missing details. A war file artifact is attached to the release.
- The Publish docker image GitHub Action to create a new demo Docker image.
- The Deploy to JLab GitHub Action to deploy to the JLab test environment.
The deploy to JLab's acctest is handled automatically via the release workflow.
At JLab this app is found at ace.jlab.org/sim and internally at acctest.acc.jlab.org/sim. However, those servers are proxies for wildfly3.acc.jlab.org and wildflytest3.acc.jlab.org respectively. A deploy script is provided on each server to automate wget and deploy. Example:
/opt/wildfly/cd/deploy.sh sim v1.2.3
JLab Internal Docs: RHEL9 Wildfly