You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-9Lines changed: 32 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Project configuration is managed through the use of YAML configuration (see reso
10
10
This section covers the mandatory pre-requisites needed to be able to run the application.
11
11
12
12
* Windows, Linux, AWS, GCP or macOS
13
-
* JDK 8+
13
+
* JDK 21 (the higher versions haven't been tested)
14
14
* Maven
15
15
* Git
16
16
* Redis (or a custom cache implementation)
@@ -113,8 +113,10 @@ mvn clean package
113
113
114
114
(4). Run Spring Boot JAR (_from project root_)
115
115
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.
@@ -165,15 +167,15 @@ The `Apache Ignite` requires additional VM parameters to be added to support Jav
165
167
```
166
168
167
169
### _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.
170
172
171
-
_application.yml:_
173
+
Pick exactly one of the following in the _application.yml:_
172
174
```yaml
173
175
spring.aerospike.host: value
174
176
```
175
177
176
-
with
178
+
or
177
179
178
180
```yaml
179
181
spring.redis.host: value
@@ -185,7 +187,28 @@ or
185
187
spring.ignite.host: value
186
188
```
187
189
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:
189
212
190
213
```yaml
191
214
spring:
@@ -195,7 +218,7 @@ For configuring single redis node, please use next properties:
195
218
port: value
196
219
```
197
220
198
-
or
221
+
For configuring Ignite backend, please use next properties:
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.
0 commit comments