Skip to content

Commit

Permalink
PO-449 update readme (#425)
Browse files Browse the repository at this point in the history
* Update readme with  Redis details

* Update readme with  Redis details
  • Loading branch information
sabahirfan authored Jul 2, 2024
1 parent 6eefa9b commit 5e9d58d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,29 @@ OPAL_TEST_USER_PASSWORD=<Ask Team Memebers>

LAUNCH_DARKLY_SDK_KEY=<Ask Team Memebers>
```

#### Caching

Redis has been configured as the default caching provider. When running docker-compose with the local configuration a Redis container will be started.

If starting the opal-fines-service from Intellij or the command line you have the following options:
Follow instructions under 'Running the application locally'

Alternatively the opal-fines-service can be run using a simple in-memory cache by starting the application with the profile in-memory-caching.

To view the cache - when running against local Redis - Intellij has a free plugin called Redis Helper.
However, if you want to view the cache in staging the plugin doesn't support SSL. Instead, install:

```bash
brew install --cask another-redis-desktop-manager
sudo xattr -rd com.apple.quarantine /Applications/Another\ Redis\ Desktop\ Manager.app
```

You can also run redis container in local docker:
```bash
docker-compose up redis
```

#### Approach 1: Dev Application (No existing dependencies)

The simplest way to run the application is using the `bootTestRun` Gradle task:
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ services:
- OPAL_FINES_DB_HOST=opal-fines-db
- OPAL_LEGACY_GATEWAY_URL=http://host.docker.internal:4553/opal
- TESTING_SUPPORT_ENDPOINTS_ENABLED=true
- OPAL_REDIS_ENABLED=true

ports:
- "4550:4550"
Expand Down

0 comments on commit 5e9d58d

Please sign in to comment.