docs: Add note about requisite docker image

igniterealtime · Jan 3, 2025 · 16b7ff1 · 16b7ff1
1 parent 7f17c71
commit 16b7ff1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git 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/...est/java/org/igniterealtime/openfire/integration/federation/FederatedTestEnvironment.java b/...est/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();