Skip to content

Commit bf39dda

Browse files
doc: Document Redis events config (TheThingsIndustries#1419)
1 parent 1c971fa commit bf39dda

File tree

4 files changed

+28
-20
lines changed

4 files changed

+28
-20
lines changed

doc/content/enterprise/docker/configuration/docker-compose-enterprise.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ services:
7070
environment:
7171
TTN_LW_BLOB_LOCAL_DIRECTORY: /srv/ttn-lorawan/public/blob
7272
TTN_LW_REDIS_ADDRESS: redis:6379
73+
TTN_LW_EVENTS_REDIS_ADDRESS: redis:6379
7374
TTN_LW_IS_DATABASE_URI: postgres://root:root@postgres:5432/ttn_lorawan?sslmode=disable
7475
TTN_LW_NOC_GRAFANA_NOC_ADDRESS: stack:1884
7576
TTN_LW_NOC_GRAFANA_TARGET_URL: http://grafana:3000

doc/content/enterprise/docker/configuration/index.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The `depends_on` field tells Docker Compose that {{% tts %}} depends on PostgreS
163163
Under the `volumes` section, volumes for the files that need to be persisted on the disk are defined. There are stored blob files (such as profile pictures) and certificate files retrieved with ACME (if required). Also, local `./config/stack/` directory is mounted on the container under `/config`, so that {{% tts %}} can find the configuration file at `/config/ttn-lw-stack-docker.yml`.
164164

165165
{{< highlight yaml "linenos=table,linenostart=65" >}}
166-
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=65 to=69 >}}
166+
{{< readfile path="/enterprise/docker/configuration/docker-compose-enterprise.yml" from=65 to=69 >}}
167167
{{< /highlight >}}
168168

169169
{{< note >}} If your `ttn-lw-stack-docker.yml` is in a directory other than `./config/stack`, you will need to change this volume accordingly. {{</ note >}}
@@ -227,16 +227,16 @@ host, and also to use it as the default host.
227227

228228
If using Let's Encrypt, certificates will automatically be requested the first time you access {{% tts %}}. You will notice that the page takes some time to load while certificates are obtained in the background.
229229

230-
{{< highlight yaml "linenos=table,linenostart=61" >}}
231-
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=61 to=71 >}}
230+
{{< highlight yaml "linenos=table,linenostart=68" >}}
231+
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=68 to=78 >}}
232232
{{< /highlight >}}
233233

234234
Make sure that you use the correct `tls` configuration depending on whether you are using Let's Encrypt or your own certificate files.
235235

236236
If you are using your own certificate files, make sure to uncomment the lines that define `source` type, `root-ca`, `certificate` and `key`. The paths assigned to these do not need to be altered, because they point to the location of these files inside the Docker container, and not on your machine.
237237

238-
{{< highlight yaml "linenos=table,linenostart=53" >}}
239-
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=53 to=59 >}}
238+
{{< highlight yaml "linenos=table,linenostart=61" >}}
239+
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=61 to=66 >}}
240240
{{< /highlight >}}
241241

242242
See the [TLS Options configuration reference]({{< ref "/enterprise/management/configuration/the-things-stack#tls-options" >}}) for more information.
@@ -247,16 +247,16 @@ Make sure that you use the correct `tls` configuration depending on whether you
247247

248248
The `console` section configures the URLs for the Web UI and the secret used by the console client. These tell {{% tts %}} where all its components are accessible. Be sure to replace these, and all the other server addresses, with yours.
249249

250-
{{< highlight yaml "linenos=table,linenostart=91" >}}
251-
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=91 to=116 >}}
250+
{{< highlight yaml "linenos=table,linenostart=98" >}}
251+
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=98 to=123 >}}
252252
{{< /highlight >}}
253253

254254
{{< warning >}} Failure to correctly configure component URLs is a common problem that will prevent the stack from starting. Be sure to replace all instances of `thethings.example.com` with your domain name! {{</ warning >}}
255255

256256
The `client-secret` will be needed later when authorizing the Console. Be sure to set and remember it!
257257

258-
{{< highlight yaml "linenos=table,linenostart=117" >}}
259-
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=117 to=122 >}}
258+
{{< highlight yaml "linenos=table,linenostart=124" >}}
259+
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=124 to=129 >}}
260260
{{< /highlight >}}
261261

262262
### Managed Gateways {{< new-in-version "3.34.0" >}}
@@ -267,14 +267,14 @@ To authenticate with The Things Gateway Controller, {{% tts %}} typically uses t
267267

268268
When using Let's Encrypt:
269269

270-
{{< highlight yaml "linenos=table,linenostart=143" >}}
271-
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=143 to=151 >}}
270+
{{< highlight yaml "linenos=table,linenostart=150" >}}
271+
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=150 to=158 >}}
272272
{{< /highlight >}}
273273

274274
When using custom certificates:
275275

276-
{{< highlight yaml "linenos=table,linenostart=152" >}}
277-
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=152 to=156 >}}
276+
{{< highlight yaml "linenos=table,linenostart=159" >}}
277+
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=159 to=163 >}}
278278
{{< /highlight >}}
279279

280280
{{< note >}} If you are using a private PKI for generating certificates (e.g. a self-signed CA), you need to share your CA file with The Things Industries in order for The Things Gateway Controller to verify your certificate and authenticate your deployment. Contact [The Things Industries support](mailto:[email protected]). {{</ note >}}
@@ -287,22 +287,22 @@ Besides `ui` and `oauth` settings, storage settings need to be configured in the
287287

288288
To authorize the NOC, be sure to set and remember the client secret.
289289

290-
{{< highlight yaml "linenos=table,linenostart=157" >}}
291-
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=157 to=175 >}}
290+
{{< highlight yaml "linenos=table,linenostart=164" >}}
291+
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=164 to=182 >}}
292292
{{< /highlight >}}
293293

294294
To visualize data, configure the `grafana` section.
295295

296-
{{< highlight yaml "linenos=table,linenostart=176" >}}
297-
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=176 to=181 >}}
296+
{{< highlight yaml "linenos=table,linenostart=183" >}}
297+
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=183 to=188 >}}
298298
{{< /highlight >}}
299299

300300
### Multi-tenancy
301301

302302
{{< distributions "Enterprise" >}} If running a multi-tenant environment, we need to configure the default tenant ID, and the base domain from which tenant IDs are inferred. See the [`tenancy` configuration reference]({{< ref "/enterprise/management/configuration/the-things-stack#multi-tenancy" >}}).
303303

304-
{{< highlight yaml "linenos=table,linenostart=188" >}}
305-
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=184 to=187 >}}
304+
{{< highlight yaml "linenos=table,linenostart=191" >}}
305+
{{< readfile path="/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml" from=191 to=194 >}}
306306
{{< /highlight >}}
307307

308308
For multi-tenant environments you'll also need to configure tenant admin keys in the `is` section:

doc/content/enterprise/docker/configuration/ttn-lw-stack-docker-custom-certificates.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ ttgc:
119119
tls:
120120
source: file
121121
certificate: /run/secrets/cert.pem
122-
key: /run/secrets\
122+
key: /run/secrets/key.pem
123123
# If using Let's Encrypt (see above):
124124
# tls:
125125
# source: acme

doc/content/enterprise/docker/configuration/ttn-lw-stack-docker-enterprise.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,13 @@ http:
5151
pprof:
5252
password: "pprof" # choose a password
5353

54+
# Events configuration
55+
events:
56+
backend: redis
57+
redis:
58+
store:
59+
enable: true
60+
5461
# If using custom certificates:
5562
#tls:
5663
# source: file

0 commit comments

Comments
 (0)