chore: add sentinel example (#61)

* chore: add sentinel example

* chore: update README.md

Author: geofmureithi

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- *chore*: add sentinel example
+
 ## [1.0.0-rc.6] - 2026-04-09
 
 - *bump*: Bump to v1.0.0-rc.7 (#58)

Cargo.lock

@@ -50,6 +50,9 @@ apalis-board = { version = "1.0.0-rc.6", features = ["axum"] }
 axum = { version = "0.8", features = ["macros", "json"] }
 tracing-subscriber = { version = "0.3.11", features = ["env-filter"] }
 tracing = "0.1"
+redis = { version = "1.0.4", default-features = false, features = [
+    "sentinel",
+] }
 
 [features]
 default = ["tokio-comp"]

Cargo.toml

@@ -6,6 +6,7 @@ Background task processing for rust using `apalis` and `redis`
 
 - **Reliable task queue** using any `redis` compatible service as the backend.
 - **Multiple storage types**: standard polling and `pubsub` based approaches.
+- **Supports Redis Sentinel**: offering high availability.
 - **Customizable codecs** for serializing/deserializing task arguments such as `json`, `msgpack` and `bincode`.
 - **Heartbeat and orphaned tasks re-enqueueing** for consistent task processing.
 - **Integration with `apalis` workers and middleware** such as `retry`, `long_running` and `parallelize`

README.md

@@ -0,0 +1 @@
+HOST_IP=

examples/sentinel/.env.example

@@ -0,0 +1,2 @@
+data
+.env

examples/sentinel/.gitignore

@@ -0,0 +1,34 @@
+# Sentinel + Apalis Redis
+
+This example covers the basics of setting up redis-sentinel and apalis-redis offering high availability.
+
+## Getting started
+
+> Setup your sentinel infra. In this example we will follow the example provided [here](https://medium.com/@mohsenmahoski/setting-up-sentinel-with-docker-compose-5cad962c7643)
+
+
+### Running locally
+
+Create a .env file with your host IP:
+
+```env
+HOST_IP=
+```
+
+I used this command:
+
+```bash
+ipconfig getifaddr en0
+```
+
+Run docker compose:
+
+```bash
+docker-compose --env-file .env up
+```
+
+Now start the worker
+
+```bash
+SENTINEL_NODES=redis://127.0.0.1:26379,redis://127.0.0.1:26380,redis://127.0.0.1:26381 cargo run cargo run --example sentinel
+```