Skip to content

Commit a7af9b5

Browse files
authored
Merge pull request TheThingsIndustries#338 from TheThingsIndustries/doc/lns-key-console
doc: Add instructions for console LNS API key
2 parents 4c4925e + d1c5200 commit a7af9b5

5 files changed

Lines changed: 27 additions & 4 deletions

File tree

508 KB
Loading

doc/content/gateways/lora-basics-station/cups.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ weight: -1
88

99
<!--more-->
1010

11-
{{< note >}} CUPS is **not required** for sending and receiving LoRaWAN data, but it simplifies gateway management.
12-
13-
CUPS support in {{% tts %}} is in beta and is subject to change. {{</ note >}}
11+
{{< note >}} CUPS is **not required** for sending and receiving LoRaWAN data, but it simplifies gateway management. CUPS support in {{% tts %}} is in beta and is subject to change. {{</ note >}}
1412

1513
{{< warning >}} Configuring CUPS automatically retrieves LNS credentials and configures LNS on your gateway. If you configure CUPS, your gateway will override LNS credentials in case of successful CUPS connection. {{</ warning >}}
1614

@@ -33,15 +31,33 @@ CUPS requires an API key for your gateway with the following rights:
3331
- Edit basic gateway settings
3432
- Retrieve secrets associated with a gateway
3533

34+
{{< figure src="../cups-rights.png" alt="CUPS API Key Rights" >}}
35+
3636
LNS requires an API Key with the following rights:
3737

3838
- Link as Gateway to a Gateway Server for traffic exchange, i.e. write uplink and read downlink
3939

40+
{{< figure src="../lns-rights.png" alt="LNS API Key Rights" >}}
41+
4042
To create an API key for your gateway, follow instructions for Creating a Gateway API key in [Adding Gateways]({{< ref "/gateways/adding-gateways" >}}).
4143

4244
## Configure CUPS to Send the LNS API Key
4345

44-
{{% cli-only %}}
46+
{{< tabs/container "Console" "CLI" >}}
47+
48+
{{< tabs/tab "Console" >}}
49+
50+
We need to configure CUPS in {{% tts %}} to transmit the LNS API key when a gateway connects. To do so in the Console, go to the **General Settings** page of your gateway.
51+
52+
In the **LoRa Basics Station LNS Authentication Key** field, paste the LNS API key you generated in the previous step.
53+
54+
{{< figure src="../lns-key.png" alt="LoRa Basics Station LNS Authentication Key" >}}
55+
56+
Press **Save Changes** to update the gateway settings. When your gateway connects to CUPS, {{% tts %}} will send the LNS configuration settings and API key.
57+
58+
{{</ tabs/tab >}}
59+
60+
{{< tabs/tab "CLI" >}}
4561

4662
We need to configure CUPS in {{% tts %}} to transmit the LNS API key when a gateway connects. Use the following command to do so, replacing `"your-gateway-id"` with your gateway ID in {{% tts %}} and `"your-lns-api-key"` with the LNS API key you created in the last step:
4763

@@ -77,6 +93,10 @@ If successful, you should receive a response as follows:
7793
```
7894
</details>
7995

96+
{{</ tabs/tab >}}
97+
98+
{{</ tabs/container >}}
99+
80100
## Configure Gateway
81101

82102
All {{% lbs %}} gateways support the following configuration options. Consult your gateway documentation for more information about configuring your specific gateway.
718 KB
Loading
505 KB
Loading

doc/content/gateways/lora-basics-station/lns.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ To connect a gateway using the LNS protocol, you must first add the gateway in {
2222
## Create an API Key
2323

2424
LNS requires an API Key with the following rights:
25+
2526
- Link as Gateway to a Gateway Server for traffic exchange, i.e. write uplink and read downlink
2627

28+
{{< figure src="../lns-rights.png" alt="LNS API Key Rights" >}}
29+
2730
To create an API key for your gateway, follow instructions for Creating a Gateway API key in [Adding Gateways]({{< ref "/gateways/adding-gateways" >}}).
2831

2932
## Configure Gateway

0 commit comments

Comments
 (0)