Skip to content

Commit 2fcd6d9

Browse files
dunglasdunglas
committed
docs: update cluster docs
1 parent 8a1d3d4 commit 2fcd6d9

File tree

2 files changed

+65
-53
lines changed

2 files changed

+65
-53
lines changed

‎docs/hub/cluster.md‎

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,18 +84,29 @@ Most Cloud Computing platforms also provide managed versions of Redis or Valkey.
8484
| Presence API | ✅ |
8585
| Custom event ID | ✅ |
8686

87+
Here is a basic example of a Redis transport configuration using environment variables:
88+
89+
```env
90+
MERCURE_EXTRA_DIRECTIVES="transport redis {
91+
url rediss://default:p@ssw0rd123@redis.example.com:6379
92+
stream mercure
93+
}"
94+
```
95+
8796
##### Redis Configuration
8897

8998
The following options can be passed to the `transport` directive:
9099

91-
| Option | Description |
92-
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
93-
| `address` or `addresses` | the address(es) of the Redis server(s), you can pass several addresses to use several Redis servers (e.g., `addresses host1:6379 host2:6379`, required) |
94-
| `stream` | the name of the Redis stream to use (required) |
95-
| `password` | the Redis password |
96-
| `tls` | enable TLS support |
97-
| `max_length` | the approximate maximum number of messages to store in the history, set to `0` to store all messages |
98-
| `gob` | use the Go `gob` encoding instead of JSON (faster but not compatible with third-party systems querying the Redis instance directly) |
100+
| Option | Description |
101+
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
102+
| `url` | The [Redis URI](https://github.com/redis/redis-specifications/blob/master/uri/redis.txt) to use to connect to Redis. If set, `address`, `addresses`, `username`, `password`, and `tls` options are ignored. |
103+
| `stream` | the name of the Redis stream to use (default to `mercure`) |
104+
| `max_length` | the approximate maximum number of messages to store in the history, set to `0` to store all messages |
105+
| `gob` | use the Go `gob` encoding instead of JSON (faster but not compatible with third-party systems querying the Redis instance directly) |
106+
| `address` or `addresses` | the address(es) of the Redis server(s), you can pass several addresses to use several Redis servers (e.g., `addresses host1:6379 host2:6379`). Prefer using `url` except if you use Redis Cluster. |
107+
| `username` | the Redis username |
108+
| `password` | the Redis password |
109+
| `tls` | enable TLS support |
99110

100111
All [the configuration parameters and formats](https://mercure.rocks/docs/hub/config) supported by the free Mercure.rocks Hub are also available.
101112

‎examples/chat/chart/mercure-example-chat/README.md‎

Lines changed: 46 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -6,50 +6,51 @@ A minimalist chat system, using Mercure and the Flask microframework to handle c
66

77
## Values
88

9-
| Key | Type | Default | Description |
10-
|-----|------|---------|-------------|
11-
| affinity | object | `{}` | |
12-
| autoscaling.enabled | bool | `false` | |
13-
| autoscaling.maxReplicas | int | `100` | |
14-
| autoscaling.minReplicas | int | `1` | |
15-
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
16-
| cookieDomain | string | `".mercure.rocks"` | |
17-
| fullnameOverride | string | `""` | |
18-
| hubUrl | string | `"https://demo.mercure.rocks/.well-known/mercure"` | |
19-
| image.pullPolicy | string | `"Always"` | |
20-
| image.repository | string | `"dunglas/mercure-example-chat"` | |
21-
| image.tag | string | `"latest"` | |
22-
| imagePullSecrets | list | `[]` | |
23-
| ingress.annotations | object | `{}` | |
24-
| ingress.className | string | `""` | |
25-
| ingress.enabled | bool | `false` | |
26-
| ingress.hosts[0].host | string | `"chart-example.local"` | |
27-
| ingress.hosts[0].paths[0].path | string | `"/"` | |
28-
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
29-
| ingress.tls | list | `[]` | |
30-
| jwtKey | string | `"!ChangeThisMercureHubJWTSecretKey!"` | |
31-
| livenessProbe.httpGet.path | string | `"/"` | |
32-
| livenessProbe.httpGet.port | string | `"http"` | |
33-
| messageUriTemplate | string | `"https://chat.example.com/messages/{id}"` | |
34-
| nameOverride | string | `""` | |
35-
| nodeSelector | object | `{}` | |
36-
| podAnnotations | object | `{}` | |
37-
| podLabels | object | `{}` | |
38-
| podSecurityContext | object | `{}` | |
39-
| readinessProbe.httpGet.path | string | `"/"` | |
40-
| readinessProbe.httpGet.port | string | `"http"` | |
41-
| replicaCount | int | `1` | |
42-
| resources | object | `{}` | |
43-
| securityContext | object | `{}` | |
44-
| service.port | int | `80` | |
45-
| service.type | string | `"ClusterIP"` | |
46-
| serviceAccount.annotations | object | `{}` | |
47-
| serviceAccount.automount | bool | `true` | |
48-
| serviceAccount.create | bool | `true` | |
49-
| serviceAccount.name | string | `""` | |
50-
| tolerations | list | `[]` | |
51-
| volumeMounts | list | `[]` | |
52-
| volumes | list | `[]` | |
9+
| Key | Type | Default | Description |
10+
| ------------------------------------------ | ------ | -------------------------------------------------- | ----------- |
11+
| affinity | object | `{}` | |
12+
| autoscaling.enabled | bool | `false` | |
13+
| autoscaling.maxReplicas | int | `100` | |
14+
| autoscaling.minReplicas | int | `1` | |
15+
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
16+
| cookieDomain | string | `".mercure.rocks"` | |
17+
| fullnameOverride | string | `""` | |
18+
| hubUrl | string | `"https://demo.mercure.rocks/.well-known/mercure"` | |
19+
| image.pullPolicy | string | `"Always"` | |
20+
| image.repository | string | `"dunglas/mercure-example-chat"` | |
21+
| image.tag | string | `"latest"` | |
22+
| imagePullSecrets | list | `[]` | |
23+
| ingress.annotations | object | `{}` | |
24+
| ingress.className | string | `""` | |
25+
| ingress.enabled | bool | `false` | |
26+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
27+
| ingress.hosts[0].paths[0].path | string | `"/"` | |
28+
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
29+
| ingress.tls | list | `[]` | |
30+
| jwtKey | string | `"!ChangeThisMercureHubJWTSecretKey!"` | |
31+
| livenessProbe.httpGet.path | string | `"/"` | |
32+
| livenessProbe.httpGet.port | string | `"http"` | |
33+
| messageUriTemplate | string | `"https://chat.example.com/messages/{id}"` | |
34+
| nameOverride | string | `""` | |
35+
| nodeSelector | object | `{}` | |
36+
| podAnnotations | object | `{}` | |
37+
| podLabels | object | `{}` | |
38+
| podSecurityContext | object | `{}` | |
39+
| readinessProbe.httpGet.path | string | `"/"` | |
40+
| readinessProbe.httpGet.port | string | `"http"` | |
41+
| replicaCount | int | `1` | |
42+
| resources | object | `{}` | |
43+
| securityContext | object | `{}` | |
44+
| service.port | int | `80` | |
45+
| service.type | string | `"ClusterIP"` | |
46+
| serviceAccount.annotations | object | `{}` | |
47+
| serviceAccount.automount | bool | `true` | |
48+
| serviceAccount.create | bool | `true` | |
49+
| serviceAccount.name | string | `""` | |
50+
| tolerations | list | `[]` | |
51+
| volumeMounts | list | `[]` | |
52+
| volumes | list | `[]` | |
53+
54+
---
5355

54-
----------------------------------------------
5556
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

0 commit comments

Comments
 (0)