Skip to content

Commit 66dc9c7

Browse files
committed
Update documentation layout.
1 parent 0ee4b2f commit 66dc9c7

File tree

22 files changed

+158
-216
lines changed

22 files changed

+158
-216
lines changed

docs/config.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
1-
baseURL = "https://docs.loraserver.io/lora-gateway-bridge/"
1+
baseURL = "https://www.loraserver.io/lora-gateway-bridge/"
22
languageCode = "en-us"
33
title = "LoRa Gateway Bridge documentation"
44
googleAnalytics = "UA-3512995-9"
55

66
[[menu.main]]
7-
pre = "<i class='fa fa-hand-o-right'></i>"
7+
pre = "<i class='fas fa-hand-point-right'></i>"
88
name = "Overview"
99
identifier = "overview"
1010
url = "/overview/"
1111
weight = 1
1212

1313
[[menu.main]]
14-
pre = "<i class='fa fa-download'></i>"
14+
pre = "<i class='fas fa-download'></i>"
1515
name = "Install"
1616
identifier = "install"
1717
url = "/install/"
1818
weight = 2
1919

2020
[[menu.main]]
21-
pre = "<i class='fa fa-user'></i>"
21+
pre = "<i class='fas fa-user'></i>"
2222
name = "Use"
2323
identifier = "use"
2424
url = "/use/"
2525
weight = 3
2626

2727
[[menu.main]]
28-
pre = "<i class='fa fa-github'></i>"
28+
pre = "<i class='fab fa-github'></i>"
2929
name = "Community & support"
3030
identifier = "community"
3131
url = "/community/"

docs/content/community/contribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
weight: 2
77
---
88

9-
## Contribute
9+
# Contribute
1010

1111
There are a couple of ways to get involved:
1212

docs/content/community/source.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ menu:
66
weight: 3
77
---
88

9-
## LoRa Gateway Bridge source
9+
# LoRa Gateway Bridge source
1010

1111
Source-code can be found at [https://github.com/brocaar/lora-gateway-bridge](https://github.com/brocaar/lora-gateway-bridge).
1212

13-
### Building
13+
## Building
1414

15-
#### With Docker
15+
### With Docker
1616

1717
The easiest way to get started is by using the provided
1818
[docker-compose](https://docs.docker.com/compose/) environment. To start a bash
@@ -23,19 +23,19 @@ the root of this project:
2323
docker-compose run --rm gatewaybridge bash
2424
```
2525

26-
#### Without Docker
26+
### Without Docker
2727

2828
It is possible to build LoRa App Server without Docker. However this requires
2929
to install a couple of dependencies (depending your platform, there might be
3030
pre-compiled packages available):
3131

32-
##### Go
32+
#### Go
3333

3434
Make sure you have [Go](https://golang.org/) installed (1.8+) and that the LoRa
3535
Gateway Bridge repository has been cloned to
3636
`$GOPATH/src/github.com/brocaar/lora-gateway-bridge`.
3737

38-
#### Example commands
38+
### Example commands
3939

4040
A few example commands that you can run:
4141

docs/content/community/support.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ menu:
66
weight: 1
77
---
88

9-
## Support
9+
# Support
1010

11-
### Bugs
11+
## Bugs
1212

1313
Did you find a bug or want to request a new feature? Please first check if
1414
this issue has already been reported. If not, please create an issue:
1515
[https://github.com/brocaar/lora-gateway-bridge/issues](https://github.com/brocaar/lora-gateway-bridge/issues).
1616

17-
### Questions
17+
## Questions
1818

1919
For support questions, please refer to the [LoRa Server project forum](https://forum.loraserver.io/).

docs/content/install/config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ menu:
66
weight: 5
77
---
88

9-
## Configuration
9+
# Configuration
1010

11-
### Gateway
11+
## Gateway
1212

1313
Modify the [packet-forwarder](https://github.com/lora-net/packet_forwarder)
1414
of your gateway so that it will send its data to the LoRa Gateway Bridge.
@@ -18,7 +18,7 @@ You will need to change the following configuration keys:
1818
* `serv_port_up` to `1700` (the default port that LoRa Gateway Bridge is using)
1919
* `serv_port_down` to `1700` (same)
2020

21-
### LoRa Gateway Bridge
21+
## LoRa Gateway Bridge
2222

2323
The `lora-gateway-bridge` has the following command-line flags:
2424

@@ -44,7 +44,7 @@ Flags:
4444
Use "lora-gateway-bridge [command] --help" for more information about a command.
4545
```
4646

47-
#### Configuration file
47+
### Configuration file
4848

4949
By default `lora-gateway-bridge` will look in the following order for a
5050
configuration at the following paths when `--config` / `-c` is not set:
@@ -158,7 +158,7 @@ tls_cert=""
158158
tls_key=""
159159
```
160160

161-
#### Warning: deprecation warning! update your configuration
161+
### Warning: deprecation warning! update your configuration
162162

163163
When you see this warning, you need to update your configuration!
164164
Before LoRa Gateway Bridge 2.3.0 environment variables were used for setting

docs/content/install/debian.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ menu:
66
weight: 4
77
---
88

9-
## Debian / Ubuntu
9+
# Debian / Ubuntu
1010

1111
These steps have been tested using:
1212

1313
* Debian Jessie
1414
* Ubuntu Trusty (14.04)
1515
* Ubuntu Xenial (16.04)
1616

17-
### LoRa Server Debian repository
17+
## LoRa Server Debian repository
1818

1919
The LoRa Server project provides pre-compiled binaries packaged as Debian (.deb)
2020
packages. In order to activate this repository, execute the following
@@ -29,7 +29,7 @@ sudo echo "deb https://repos.loraserver.io/${DISTRIB_ID,,} ${DISTRIB_CODENAME} t
2929
sudo apt-get update
3030
```
3131

32-
### Install LoRa Gateway Bridge
32+
## Install LoRa Gateway Bridge
3333

3434
In order to install LoRa Gateway Bridge, execute the following command:
3535

@@ -41,24 +41,24 @@ This will setup an user and group, create start scripts for systemd or init.d
4141
(this depends on your version of Debian / Ubuntu). The configuration file is
4242
located at `/etc/lora-gateway-bridge/lora-gateway-bridge.toml`.
4343

44-
### Starting LoRa Gateway Bridge
44+
## Starting LoRa Gateway Bridge
4545

4646
How you need to (re)start and stop LoRa Gateway Bridge depends on if your
4747
platform uses systemd or init.d.
4848

49-
#### systemd
49+
### systemd
5050

5151
```bash
5252
sudo systemctl [start|stop|restart|status] lora-gateway-bridge
5353
```
5454

55-
#### init.d
55+
### init.d
5656

5757
```bash
5858
sudo /etc/init.d/lora-gateway-bridge [start|stop|restart|status]
5959
```
6060

61-
### LoRa Gateway log output
61+
## LoRa Gateway log output
6262

6363
Now you've setup LoRa Gateway Bridge and your gateway is configured to forward
6464
it's data to it, it is a good time to verify that data is actually comming in.
@@ -67,7 +67,7 @@ This can be done by looking at the LoRa Gateway Bridge log output.
6767
Like the previous step, which command you need to use for viewing the
6868
log output depends on if your distribution uses init.d or systemd.
6969

70-
#### init.d
70+
### init.d
7171

7272
All logs are written to `/var/log/lora-gateway-bridge/lora-gateway-bridge.log`.
7373
To view and follow this logfile:
@@ -76,7 +76,7 @@ To view and follow this logfile:
7676
tail -f /var/log/lora-gateway-bridge/lora-gateway-bridge.log
7777
```
7878

79-
#### systemd
79+
### systemd
8080

8181
```bash
8282
journalctl -u lora-gateway-bridge -f -n 50
@@ -103,7 +103,7 @@ lora-gateway-bridge[9714]: time="2016-08-19T09:05:34+02:00" level=info msg="gate
103103
For an explanation of the different types of data you can receive from and
104104
send to the LoRa Gateway Bridge see [send / receive data]({{< ref "use/data.md" >}}).
105105

106-
### Install other components
106+
## Install other components
107107

108108
A complete LoRa Server setup, requires the setup of the following components:
109109

docs/content/install/debug.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ menu:
66
weight: 6
77
---
88

9-
## Debugging
9+
# Debugging
1010

1111
The follwing steps can be used to debug any LoRa Gateway Bridge related issues.
1212

13-
### Receiving MQTT messages
13+
## Receiving MQTT messages
1414

1515
To validate that the LoRa Gateway Bridge is publishing LoRa frames to the
1616
MQTT broker, you can subscribe to the `gateway/+/rx` MQTT topic. When using
@@ -29,7 +29,7 @@ When you don't see any frames appearing, this could be caused by the following i
2929
* The MQTT credentials / authorizations are invalid (the user is not authorized
3030
to subscribe to the MQTT topic)
3131

32-
### Is LoRa Gateway Bridge receiving data
32+
## Is LoRa Gateway Bridge receiving data
3333

3434
To validate that the LoRa Gateway Bridge is receiving, you can take a look
3535
at the LoRa Gateway Bridge logs. How to retrieve the logs depends on how you
@@ -67,7 +67,7 @@ be caused by:
6767
* The node is sending on a frequency that the packet-forwarder is not
6868
configured for.
6969

70-
### Is the packet-forwarder running
70+
## Is the packet-forwarder running
7171

7272
To validate that the packet-forwarder is running, you could execute the
7373
following command on your gateway:
@@ -129,7 +129,7 @@ When you don't see any of these, this could be caused by the following issues:
129129
* The packet-forwarder is not running
130130
* The packet-forwarder is forwarding to a different host / port
131131

132-
### Where is the packet-forwarder sending data to
132+
## Where is the packet-forwarder sending data to
133133

134134
Inspect the `local_conf.json` of the packet-forwarder running on your gateway.
135135
You might need to refer to your gateway manual to find out where you can locate

docs/content/install/deployment.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ menu:
66
weight: 2
77
---
88

9-
## Deployment strategies
9+
# Deployment strategies
1010

1111
There are multiple ways that you can deploy the LoRa Gateway Bridge:
1212

13-
### Single instance
13+
## Single instance
1414

1515
The most basic strategy is to connect all your gateways to a single instance
1616
of the LoRa Gateway Bridge. This is the easiest option, as installing the
@@ -20,7 +20,7 @@ The UDP protocol implemented by most gateways don't support support any
2020
form of authorization and checks that the received data is authentic. It is
2121
however an easy way to get started.
2222

23-
### Multiple instances
23+
## Multiple instances
2424

2525
For performance and to make the LoRa Gateway Bridge highly available, you
2626
can run LoRa Gateway Bridge on multiple servers, each connecting to the same
@@ -30,23 +30,23 @@ MQTT broker.
3030
Bridge cluster, make sure that each gateway connection is always routed to the
3131
same instance!
3232

33-
### On each gateway
33+
## On each gateway
3434

3535
Depending on the capabilities of your gateway, you can deploy the LoRa Gateway
3636
Bridge on each of your gateways. This might require a few additional steps in
3737
the setup, but has the following advantages:
3838

39-
#### MQTT (using TCP) over UDP
39+
### MQTT (using TCP) over UDP
4040

4141
By using MQTT (which uses TCP) over UDP, the connection becomes more reliable
4242
in case packetloss is common.
4343

44-
#### Authentication
44+
### Authentication
4545

4646
It is possible to setup credentials for each gateway, meaning you know where
4747
your data is coming from.
4848

49-
#### SSL/TLS
49+
### SSL/TLS
5050

5151
The MQTT protocol supports SSL/TLS meaning that you are able to setup a secure
5252
connection between your gateways and your MQTT broker. This not any means that

docs/content/install/gateway/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ menu:
77
identifier: gateway
88
---
99

10-
## Install on the gateway
10+
# Install on the gateway
1111

12-
### Vendors
12+
## Vendors
1313

1414
Instructions are available for the following vendors:
1515

@@ -21,7 +21,7 @@ Instructions are available for the following vendors:
2121
For Raspberry Pi / Rasbian based gateways, please refer the
2222
[Debian / Ubuntu]({{< ref "install/debian.md" >}}) installation instructions.
2323

24-
### Contribute
24+
## Contribute
2525

2626
Help us making the above list complete! Is the gateway that you are using not
2727
listed in the above vendors list? Or are the steps described outdated?

docs/content/install/gateway/kerlink.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ menu:
55
parent: gateway
66
---
77

8+
# Kerlink
89

9-
### Kerlink IOT station
10+
## Kerlink IOT station
1011

1112
The Kerlink IOT station has a meganism to start "custom" application on boot.
1213
These steps will install the LoRa Gateway Bridge ARM build on the Kerlink.

0 commit comments

Comments
 (0)