Skip to content

Commit d775061

Browse files
Clean up
Signed-off-by: Artem Savchenko <armisav@gmail.com>
1 parent 32e37f5 commit d775061

File tree

1 file changed

+29
-5
lines changed

1 file changed

+29
-5
lines changed

README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Please use this README if you want to deploy Huly on your server with `docker compose`. I'm using a Basic Droplet on Digital Ocean with Ubuntu 24.04, but these instructions can be easily adapted for any Linux distribution.
44

5-
If you prefer Kubernetes deployment, there is a sample Kubernetes configuration under [kube](kube) directory. To deploy with [Coolify](https://coolify.io) using a PostgreSQL-based stack and Coolify's built-in proxy, use the [Coolify deployment guide](guides/coolify-deployment.md) and set the compose path to `coolify/docker-compose.yaml` in Coolify's Docker Compose build pack.
5+
If you prefer Kubernetes deployment, there is a sample Kubernetes configuration under [kube](kube) directory.
66

77
## System Requirements
88

@@ -460,15 +460,22 @@ Note that the `LIVEKIT_HOST` should include the protocol (`wss://` by default if
460460

461461
## HulyPulse (Push / real-time updates)
462462

463-
HulyPulse provides WebSocket push notifications and real-time updates. It requires Redis.
463+
HulyPulse provides WebSocket push notifications and real-time updates.
464464
It will allow the following functions to work:
465465
- The knock and invite features in video calls
466466
- Information about who is viewing/editing objects right now
467467
- Shows that someone is typing a message in a chat.
468468

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

470-
1. Enable Redis and HulyPulse in `compose.yml`:
471-
- Uncomment the `redis` service.
472+
- `HULY_BACKEND=memory`
473+
474+
This mode does not require Redis and is suitable for single-node or small self-hosted deployments.
475+
476+
### Enabling HulyPulse (in-memory backend)
477+
478+
1. Enable HulyPulse in `compose.yml`:
472479
- Uncomment the `hulypulse` service.
473480

474481
2. Configure the `transactor` service:
@@ -503,7 +510,24 @@ It will allow the following functions to work:
503510
docker compose up -d --force-recreate
504511
```
505512

506-
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`).
513+
### Using Redis as backend (optional)
514+
515+
Redis can be used as an alternative backend for HulyPulse – for example, in multi-node or higher-availability setups.
516+
517+
1. Enable Redis and HulyPulse in `compose.yml`:
518+
- Uncomment the `redis` service.
519+
- Uncomment the `hulypulse` service.
520+
- In the `hulypulse` environment, switch to Redis:
521+
522+
```yaml
523+
- HULY_BACKEND=redis
524+
- HULY_REDIS_MODE=direct
525+
- HULY_REDIS_URLS=redis://redis:6379
526+
# or with password:
527+
# - HULY_REDIS_URLS=redis://:YOUR_PASSWORD@redis:6379
528+
```
529+
530+
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`).
507531

508532
## Print Service
509533

0 commit comments

Comments
 (0)