Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README for forms-flow-redis #2386

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Updated README for forms-flow-redis #2386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions forms-flow-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions forms-flow-documents/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
33 changes: 33 additions & 0 deletions forms-flow-redis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading