Skip to content

Commit 791f7ac

Browse files
Hulypulse in-memory config
Signed-off-by: Artem Savchenko <armisav@gmail.com>
1 parent a5fa04c commit 791f7ac

File tree

2 files changed

+33
-8
lines changed

2 files changed

+33
-8
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -440,15 +440,22 @@ Note that the `LIVEKIT_HOST` should include the protocol (`wss://` by default if
440440

441441
## HulyPulse (Push / real-time updates)
442442

443-
HulyPulse provides WebSocket push notifications and real-time updates. It requires Redis.
443+
HulyPulse provides WebSocket push notifications and real-time updates.
444444
It will allow the following functions to work:
445445
- The knock and invite features in video calls
446446
- Information about who is viewing/editing objects right now
447447
- Shows that someone is typing a message in a chat.
448448

449+
Since Huly platform version `v0.7.375`, HulyPulse supports an **in-memory backend**.
450+
By default, templates in this repository use:
449451

450-
1. Enable Redis and HulyPulse in `compose.yml`:
451-
- Uncomment the `redis` service.
452+
- `HULY_BACKEND=memory`
453+
454+
This mode does not require Redis and is suitable for single-node or small self-hosted deployments.
455+
456+
### Enabling HulyPulse (in-memory backend)
457+
458+
1. Enable HulyPulse in `compose.yml`:
452459
- Uncomment the `hulypulse` service.
453460

454461
2. Configure the `transactor` service:
@@ -483,7 +490,24 @@ It will allow the following functions to work:
483490
docker compose up -d --force-recreate
484491
```
485492

486-
Redis is configured with a 512 MB memory limit by default. For production you may want to set a Redis password and use `HULY_REDIS_URLS=redis://:YOUR_PASSWORD@redis:6379` in the `hulypulse` environment. The image tag uses `HULY_PULSE_VERSION` if set (default `0.1.29`).
493+
### Using Redis as backend (optional)
494+
495+
Redis can be used as an alternative backend for HulyPulse – for example, in multi-node or higher-availability setups.
496+
497+
1. Enable Redis and HulyPulse in `compose.yml`:
498+
- Uncomment the `redis` service.
499+
- Uncomment the `hulypulse` service.
500+
- In the `hulypulse` environment, switch to Redis:
501+
502+
```yaml
503+
- HULY_BACKEND=redis
504+
- HULY_REDIS_MODE=direct
505+
- HULY_REDIS_URLS=redis://redis:6379
506+
# or with password:
507+
# - HULY_REDIS_URLS=redis://:YOUR_PASSWORD@redis:6379
508+
```
509+
510+
2. Redis is configured with a 512 MB memory limit by default in the provided `compose.yml`. Adjust limits, password, and URLs as needed for your production setup. The image tag uses `HULY_PULSE_VERSION` if set (default `0.1.29`).
487511

488512
## Print Service
489513

compose.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,14 +117,15 @@ services:
117117
# - HULY_LOG=info
118118
# - HULY_TOKEN_SECRET=${SECRET}
119119
# - HULY_HEARTBEAT_TIMEOUT=60
120-
# - HULY_REDIS_MODE=direct
121-
# - HULY_REDIS_URLS=redis://redis:6379
120+
# - HULY_BACKEND=memory
121+
# # For Redis backend instead of in-memory (optional, e.g. multi-node setups):
122+
# # - HULY_BACKEND=redis
123+
# # - HULY_REDIS_MODE=direct
124+
# # - HULY_REDIS_URLS=redis://redis:6379
122125
# deploy:
123126
# resources:
124127
# limits:
125128
# memory: 512M
126-
# depends_on:
127-
# - redis
128129
# restart: unless-stopped
129130
# networks:
130131
# - huly_net

0 commit comments

Comments
 (0)