Skip to content

Commit

Permalink
doc: Document The Things Industries Gateway Protocol
Browse files Browse the repository at this point in the history
  • Loading branch information
johanstokking committed Sep 23, 2024
1 parent a1cc320 commit 19549e7
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
21 changes: 21 additions & 0 deletions doc/content/gateways/concepts/ttigw/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "The Things Industries Gateway Protocol"
description: ""
weight: -1
---

{{% ttigw %}} is a proprietary protocol developed by The Things Industries. Unlike other protocols like [{{% lbs %}}]({{< relref "../lora-basics-station" >}}) and [{{% udp-pf %}}]({{< relref "../udp" >}}), {{% ttigw %}} can only be used by gateways provisioned by The Things Industries.

<!--more-->

{{% ttigw %}} is the most secure and bandwidth efficient protocol, designed for deploying gateways in public locations that may be using a metered backhaul like cellular.

## Security

{{% ttigw %}} allows for managing the gateway from {{% tts %}} in a true zero-touch fashion. Gateways supporting this protocol therefore do not require a local user interface for any local configuration, meaning that it is impossible to tamper with configuration even with physical access to the gateway. Since all configuration is done in {{% tts %}}, you don't need to be near the gateway for onboarding and configuration.

{{% ttigw %}} enabled gateways use a TLS client certificate signed by The Things Industries to securely authenticate with any {{% tts %}} deployment: Cloud, Enterprise, Sandbox and Open Source.

## Supported Gateways

[{{% ttigpro %}}]({{< relref "../../models/thethingsindoorgatewaypro" >}}) supports {{% ttigw %}}.
3 changes: 1 addition & 2 deletions doc/content/reference/packet-forwarder/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This reference describes support for various Packet Forwarders in {{% tts %}}.

<!--more-->

{{% tts %}} supports [{{% lbs %}}]({{< ref "/gateways/concepts/lora-basics-station" >}}). There is also legacy support for the [{{% udp-pf %}}]({{< ref "/gateways/concepts/udp" >}}), but it will be removed in the future.
{{% tts %}} supports [{{% ttigw %}}]({{< ref "/gateways/concepts/ttigw" >}}) and [{{% lbs %}}]({{< ref "/gateways/concepts/lora-basics-station" >}}). There is also legacy support for the [{{% udp-pf %}}]({{< ref "/gateways/concepts/udp" >}}), but it will be removed in the future.

{{% lbs %}} is the preferred way of connecting gateways to {{% tts %}}. The advantages of {{% lbs %}} over the legacy UDP Packet Forwarder are centralized update and configuration management for gateway fleets, TLS and token-based authentication, centralized channel plan management, and no dependency on local timekeeping.

Expand All @@ -15,4 +15,3 @@ The following packet forwarders are **not** supported:
- [The Things Network Packet Forwarder](https://github.com/TheThingsNetwork/packet_forwarder)
- [Kersing Packet Forwarder](https://github.com/kersing/packet_forwarder)
- [Chirpstack Gateway Bridge](https://www.chirpstack.io/gateway-bridge/)

1 change: 1 addition & 0 deletions doc/themes/the-things-stack/layouts/shortcodes/ttigw.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{- printf "The Things Industries Gateway Protocol" -}}

0 comments on commit 19549e7

Please sign in to comment.