Skip to content

Commit 95dcc81

Browse files
committed
Update README.md
1 parent da318a6 commit 95dcc81

File tree

1 file changed

+32
-9
lines changed

1 file changed

+32
-9
lines changed

README.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Project configuration is managed through the use of YAML configuration (see reso
1010
This section covers the mandatory pre-requisites needed to be able to run the application.
1111

1212
* Windows, Linux, AWS, GCP or macOS
13-
* JDK 8+
13+
* JDK 21 (the higher versions haven't been tested)
1414
* Maven
1515
* Git
1616
* Redis (or a custom cache implementation)
@@ -113,8 +113,10 @@ mvn clean package
113113

114114
(4). Run Spring Boot JAR (_from project root_)
115115

116+
Note: at least one storage backend must be configured to make the application start up successfully. For the local start-up the `local` profile has the Aerospike configured with default settings.
117+
116118
```bash
117-
java -jar target/prebid-cache.jar
119+
java -Dspring.profiles.active=manage,local -jar target/prebid-cache.jar
118120
```
119121

120122
### _Spring Profiles_
@@ -165,15 +167,15 @@ The `Apache Ignite` requires additional VM parameters to be added to support Jav
165167
```
166168

167169
### _Cache Configuration_
168-
Prebid cache uses Aerospike as a default cache implementation but also supports Redis and Apache Ignite. For switching from Aerospike
169-
to Redis replace next:
170+
Enable **one and only one** backend in your application properties (Redis, Aerospike, or Apache Ignite). If none or more than one are configured, startup will fail.
171+
Prebid cache uses Aerospike as a default cache implementation.
170172

171-
_application.yml:_
173+
Pick exactly one of the following in the _application.yml:_
172174
```yaml
173175
spring.aerospike.host: value
174176
```
175177
176-
with
178+
or
177179
178180
```yaml
179181
spring.redis.host: value
@@ -185,7 +187,28 @@ or
185187
spring.ignite.host: value
186188
```
187189
188-
For configuring single redis node, please use next properties:
190+
For configuring Aerospike backend, you can start with the following local-profile default properties:
191+
```yaml
192+
spring:
193+
aerospike:
194+
port: 3000
195+
host: localhost
196+
cores: 4
197+
password:
198+
first_backoff: 300
199+
max_backoff: 1000
200+
max_retry: 3
201+
namespace: "prebid_cache"
202+
prevent_UUID_duplication: true
203+
socket_timeout: 30000
204+
total_timeout: 1000
205+
connect_timeout: 0
206+
min_conns_per_node: 0
207+
max_conns_per_node: 100
208+
read_policy: sequence
209+
```
210+
211+
For configuring single Redis node, please use next properties:
189212
190213
```yaml
191214
spring:
@@ -195,7 +218,7 @@ For configuring single redis node, please use next properties:
195218
port: value
196219
```
197220
198-
or
221+
For configuring Ignite backend, please use next properties:
199222
```yaml
200223
spring:
201224
ignite:
@@ -384,7 +407,7 @@ _src/main/resources/log4j-dev.xml_:
384407
```
385408

386409
### _Circuit Breaker_
387-
To make prebid-cache more robust in face of network disruption or dependent services outage circuit breaker is available and should be configured at application.yml.
410+
To make prebid-cache more robust in face of network disruption or dependent services outage circuit breaker is available and should be configured at application.yml.
388411

389412
_src/main/resources/application.yml_:
390413
```yaml

0 commit comments

Comments
 (0)