Updated README for forms-flow-redis

AOT-Technologies · Nov 27, 2024 · 1d3c742 · 1d3c742
1 parent 0061580
commit 1d3c742
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/forms-flow-api/README.md b/forms-flow-api/README.md
@@ -25,6 +25,8 @@ the system. It is built using Python :snake: .
 
 * For docker based installation [Docker](https://docker.com) need to be installed.
 * Admin access to [Keycloak](../forms-flow-idm/keycloak) server and ensure audience(camunda-rest-api) is setup in Keycloak-bpm server.
+* Ensure that the `forms-flow-redis` service is running and accessible on port `6379`. For more details, refer to the [forms-flow-redis README](../forms-flow-redis/README.md).
+
 
 ## Solution Setup
 

diff --git a/forms-flow-documents/README.md b/forms-flow-documents/README.md
@@ -208,6 +208,8 @@ template should be valid jinja template.
 
 * For docker based installation [Docker](https://docker.com) need to be installed.
 * Admin access to [Keycloak](../forms-flow-idm/keycloak) server and ensure audience(camunda-rest-api) is setup in Keycloak-bpm server.
+* Ensure that the `forms-flow-redis` service is running and accessible on port `6379`. For more details, refer to the [forms-flow-redis README](../forms-flow-redis/README.md).
+
 
 ## Solution Setup
 

diff --git a/forms-flow-redis/README.md b/forms-flow-redis/README.md
@@ -0,0 +1,33 @@
+# formsflow.ai Redis
+
+This repository contains a Docker Compose configuration to set up a lightweight Redis service using the official Redis Alpine image.
+
+
+## Table of Content
+
+1. [Prerequisites](#prerequisites)
+2. [Running the Application](#running-the-application)
+
+## Prerequisites
+
+* For docker based installation [Docker](https://docker.com) need to be installed.
+
+### Running the Application
+
+* forms-flow-redis service uses port 6379, make sure the port is available.
+* `cd {Your Directory}/forms-flow-ai/forms-flow-redis`
+
+* Run `docker-compose up -d` to start.
+
+#### To Stop the Application
+
+* Run `docker-compose stop` to stop.
+
+### Important Note
+
+The forms-flow-redis service must be up and running before installing and starting the following services:
+
+- forms-flow-api
+- forms-flow-documents-api
+
+Ensure that Redis is functional and accessible on port 6379 before proceeding with the installation of these dependent services. Failure to start forms-flow-redis first may result in errors during the initialization or runtime of the dependent applications.