Skip to content

Commit

Permalink
Update README with redis eviction notes (#1298)
Browse files Browse the repository at this point in the history
README has been updated with appropriate notes on redis eviction
considerations.
  • Loading branch information
jaymell authored Apr 25, 2024
1 parent 03ab8b9 commit 355ed06
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,14 @@ If you already have one, you just need to run `cargo build`, otherwise, please p
The server requires the following runtime dependencies to work correctly:

- A PostgreSQL server - for the storage of events.
- An *optional* Redis server version 6.2.0 or higher - for the task queue and cache. Please note that it's recommended to enable persistence in Redis so that tasks are persisted across Redis server restarts and upgrades.
- An *optional* Redis server version 6.2.0 or higher - for the task queue and cache.

## Redis/Valkey Considerations
### Persistence
Please note that it's recommended to enable persistence in Redis so that tasks are persisted across Redis server restarts and upgrades.

### Eviction Policy
Please ensure that your Redis instances are configured to not evict keys without explicit `expire` policies set. This means that `maxmemory-policy` should be set to `noeviction` or to any of the available `volatile-` policies. See Redis/Valkey documentation for further information.

## Server configuration

Expand Down

0 comments on commit 355ed06

Please sign in to comment.