From 16b7ff1dd70eb3c93ebb73c7363e997b8681d59b Mon Sep 17 00:00:00 2001
From: Matthew Vivian <matthew.vivian@surevine.com>
Date: Fri, 3 Jan 2025 15:24:25 +0000
Subject: [PATCH] docs: Add note about requisite docker image

---
 README.md                                                 | 8 ++++++++
 .../integration/federation/FederatedTestEnvironment.java  | 1 +
 2 files changed, 9 insertions(+)

diff --git a/README.md b/README.md
index d0b85c6..33a71cf 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,14 @@ Integration tests for Openfire, focusing on federation scenarios.
 - Java 17
 - Docker and Docker Compose
 
+The [openfire-docker-compose](https://github.com/surevine/openfire-docker-compose) system used by these tests expects 
+to find an image tagged as openfire:latest locally. To build one, from 
+the [openfire](https://github.com/igniterealtime/Openfire) project root:
+
+```bash
+docker build -t openfire:latest .
+```
+
 ## Setup
 
 1. Clone this repository:
diff --git a/src/test/java/org/igniterealtime/openfire/integration/federation/FederatedTestEnvironment.java b/src/test/java/org/igniterealtime/openfire/integration/federation/FederatedTestEnvironment.java
index a91eefa..0c6d4a7 100644
--- a/src/test/java/org/igniterealtime/openfire/integration/federation/FederatedTestEnvironment.java
+++ b/src/test/java/org/igniterealtime/openfire/integration/federation/FederatedTestEnvironment.java
@@ -75,6 +75,7 @@ private static void startFederatedEnvironment() throws IOException, InterruptedE
                 .directory(new File("."))
                 .inheritIO();
 
+        // TODO - check external environment first before setting this
         processBuilder.environment().put("OPENFIRE_TAG", "latest");
 
         Process process = processBuilder.start();