Skip to content

Commit 22f46bc

Browse files
committed
Rename to ChirpStack Gateway OS.
1 parent b5d2e9b commit 22f46bc

File tree

95 files changed

+379
-517
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+379
-517
lines changed

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@
1818
path = layers/mender/meta-mender
1919
url = https://github.com/mendersoftware/meta-mender.git
2020
branch = thud
21+
[submodule "docs/themes/chirpstack-hugo-theme"]
22+
path = docs/themes/chirpstack-hugo-theme
23+
url = git@github.com:brocaar/chirpstack-hugo-theme.git

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
FROM ubuntu:bionic
22
# FROM debian:9
33

4-
ENV PROJECT_PATH=/lora-gateway-os
4+
ENV PROJECT_PATH=/chirpstack-gateway-os
55
WORKDIR $PROJECT_PATH
66

77
RUN apt update && \

README.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
1-
# LoRa Gateway OS
1+
# ChirpStack Gateway OS
22

3-
The LoRa Gateway OS is an embedded OS for LoRa gateways. It is part of the
4-
open-source [LoRa Server project](https://www.loraserver.io/).
3+
The ChirpStack Gateway OS is an embedded OS for LoRa gateways. It is part of the
4+
[ChirpStack](https://www.chirpstack.io/) open-source LoRaWAN Network Server stack.
55

6-
The goal of the LoRa Gateway OS is to provide firmware images that are easy
6+
The goal of the ChirpStack Gateway OS is to provide firmware images that are easy
77
to setup, maintain and customize.
88

99
## Images
1010

11-
### lora-gateway-os-base
11+
### chirpstack-gateway-os-base
1212

13-
An image providing the Semtech packet-forwarder and LoRa Gateway Bridge.
13+
An image providing the Semtech Packet Forwarder and ChirpStack Gateway Bridge.
1414

1515
Provides the following features:
1616

1717
* [Monit](https://mmonit.com/monit/) based service monitoring
18-
* Semtech [packet-forwarder](https://github.com/lora-net/packet_forwarder)
19-
* [LoRa Gateway Bridge](https://github.com/brocaar/lora-gateway-bridge/)
18+
* Semtech [Packet Forwarder](https://github.com/lora-net/packet_forwarder)
19+
* [ChirpStack Gateway Bridge](https://www.chirpstack.io/gateway-bridge/)
2020

21-
### lora-gateway-os-full
21+
### chirpstack-gateway-os-full
2222

2323
An image providing a complete LoRaWAN network-server running on the
2424
gateway.
2525

2626
Provides the following features:
2727

2828
* [Monit](https://mmonit.com/monit/) based service monitoring
29-
* Semtech [packet-forwarder](https://github.com/lora-net/packet_forwarder)
30-
* [LoRa Gateway Bridge](https://github.com/brocaar/lora-gateway-bridge/)
31-
* [LoRa Server](https://github.com/brocaar/loraserver)
32-
* [LoRa App Server](https://github.com/brocaar/lora-app-server)
29+
* Semtech [Packet Forwarder](https://github.com/lora-net/packet_forwarder)
30+
* [ChirpStack Gateway Bridge](https://www.chirpstack.io/gateway-bridge/)
31+
* [ChirpStack Network Server](https://www.chirpstack.io/network-server/)
32+
* [ChirpStack Application Server](https://www.chirpstack.io/application-server/)
3333
* [Mosquitto MQTT broker](http://mosquitto.org/)
3434
* [Redis](https://redis.io/)
3535
* [PostgreSQL](https://www.postgresql.org/)
@@ -99,11 +99,11 @@ docker-compose run --rm yocto bash
9999
# within the container
100100

101101
# initialize the yocto / openembedded build environment
102-
source oe-init-build-env /build/ /lora-gateway-os/bitbake/
102+
source oe-init-build-env /build/ /chirpstack-gateway-os/bitbake/
103103

104104

105-
# build the lora-gateway-os-base image
106-
bitbake lora-gateway-os-base
105+
# build the chirpstack-gateway-os-base image
106+
bitbake chirpstack-gateway-os-base
107107
```
108108

109109
#### Configuration
@@ -118,17 +118,13 @@ update the following configuration files to configure a different target:
118118

119119
### SD Card wearout
120120

121-
Although LoRa Server tries to minimize the number of database writes, there
122-
will be regular writes to the SD Card (PostgreSQL and Redis snapshots).
121+
Although ChirpStack Network Server and ChirpStack Application Server try to minimize
122+
the number of database writes, there will be regular writes to the SD Card
123+
(PostgreSQL and Redis snapshots).
123124
According to [Is it true that a SD/MMC Card does wear levelling with its own controller?](https://electronics.stackexchange.com/questions/27619/is-it-true-that-a-sd-mmc-card-does-wear-levelling-with-its-own-controller)
124125
it might make a difference which SD Card brand you use.
125126

126-
### Updates
127-
128-
(Currently) the LoRa Server project does not provide package updates.
129-
However, each image includes the `opkg` package manager,
130-
131127
### Versioning
132128

133129
The major version (major.minor.patch) of this project represents the major
134-
version of the provided LoRa Server components.
130+
version of the provided ChirpStack Network Server stack.

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ services:
1313
nocopy: true
1414
- type: bind
1515
source: .
16-
target: /lora-gateway-os
16+
target: /chirpstack-gateway-os
1717

1818
busybox:
1919
image: busybox

docs/config.toml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
baseURL = "https://www.loraserver.io/lora-gateway-os/"
1+
baseURL = "https://www.chirpstack.io/gateway-os/"
22
languageCode = "en-us"
3-
title = "LoRa Gateway OS documentation"
3+
title = "ChirpStack Gateway OS documentation"
44
googleAnalytics = "UA-3512995-9"
55
pygmentsUseClasses = true
6+
theme = "chirpstack-hugo-theme"
67

78
[[menu.main]]
89
pre = "<i class='fas fa-hand-point-right'></i>"
@@ -33,6 +34,7 @@ pygmentsUseClasses = true
3334
weight = 4
3435

3536
[params]
36-
raspberrypi_raspberrypi3_version = "3.0.0test2"
37-
wifx_lorix_one_sd_version = "3.0.0test2"
38-
wifx_lorix_one_512_sd_version = "3.0.0test2"
37+
raspberrypi_raspberrypi3_version = "3.1.0test1"
38+
wifx_lorix_one_sd_version = "3.1.0test1"
39+
wifx_lorix_one_512_sd_version = "3.1.0test1"
40+
component = "chirpstack-gateway-os"

docs/content/community/contribute.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ menu:
44
main:
55
parent: community
66
weight: 2
7-
description: Information how you can contribute to the LoRa Gateway OS project.
7+
description: Information how you can contribute to the ChirpStack Gateway OS project.
88
---
99

1010
# Contribute
1111

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

1414
* Join the discussions:
15-
* LoRa Server project forum [https://forum.loraserver.io/](https://forum.loraserver.io/)
16-
* Report bugs or make feature-requests by opening an issue at [https://github.com/brocaar/lora-gateway-os/issues](https://github.com/brocaar/lora-gateway-os/issues)
15+
* ChirpStack community forum [https://forum.chirpstack.io/](https://forum.chirpstack.io/)
16+
* Report bugs or make feature-requests by opening an issue at [https://github.com/brocaar/chirpstack-gateway-os/issues](https://github.com/brocaar/chirpstack-gateway-os/issues)
1717
* Help fixing issues or improve documentation by creating pull-requests
1818

1919

docs/content/community/source.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ menu:
44
main:
55
parent: community
66
weight: 3
7-
description: How to compile the LoRa Gateway OS images yourself.
7+
description: How to compile the ChirpStack Gateway OS images yourself.
88
---
99

10-
# LoRa Gateway OS source
10+
# ChirpStack Gateway OS source
1111

1212
The [Yocto](https://www.yoctoproject.org/) recipes can be found at:
13-
[https://github.com/brocaar/lora-gateway-os](https://github.com/brocaar/lora-gateway-os).
13+
[https://github.com/brocaar/chirpstack-gateway-os](https://github.com/brocaar/chirpstack-gateway-os).
1414

1515
## Building
1616

17-
The LoRa Gateway OS uses [Docker](https://www.docker.com/) and
17+
The ChirpStack Gateway OS uses [Docker](https://www.docker.com/) and
1818
[Docker Compose](https://docs.docker.com/compose/). Make sure you have
1919
these tools installed.
2020

@@ -45,11 +45,11 @@ docker-compose run --rm yocto bash
4545
make submodules
4646

4747
# initialize the yocto / openembedded build environment
48-
source oe-init-build-env /build/ /lora-gateway-os/bitbake/
48+
source oe-init-build-env /build/ /chirpstack-gateway-os/bitbake/
4949

5050

51-
# build the lora-gateway-os-base image
52-
bitbake lora-gateway-os-base
51+
# build the chirpstack-gateway-os-base image
52+
bitbake chirpstack-gateway-os-base
5353
```
5454

5555
#### Configuration
@@ -58,4 +58,4 @@ By default, Raspberry Pi3 is configured as the target platform. You need to
5858
update the following configuration files to configure a different target:
5959

6060
* `/build/config/local.conf`
61-
* `/build/config/bblayers.conf`
61+
* `/build/config/bblayers.conf`

docs/content/community/support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ description: Where to report bugs, discuss new features and get support from the
1313

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

1818
## Questions
1919

20-
For support questions, please refer to the [LoRa Server project forum](https://forum.loraserver.io/).
20+
For support questions, please refer to the [ChirpStack community forum](https://forum.chirpstack.io/).

docs/content/install/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
title: LoRa Gateway OS installation
2+
title: ChirpStack Gateway OS installation
33
menu:
44
main:
55
parent: install
66
weight: 1
77
hidden: true
88
---
99

10-
# LoRa Gateway OS installation
10+
# ChirpStack Gateway OS installation
1111

1212
**Important:** If your gateway is not in the list below then you can still use
13-
the LoRa Server project! The LoRa Gateway OS is only to make things more easy,
14-
it is not a requirement.
13+
the ChirpStack open-source LoRaWAN<sup>&reg;</sup> Network Server stack! The ChirpStack
14+
Gateway OS is only to make things more easy, it is not a requirement.
1515

1616
If you are a gateway vendor and would like to see your gateway added to the
17-
list, please reach out!
17+
list, please reach out!

docs/content/install/raspberrypi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Raspberry Pi
33
menu:
44
main:
55
parent: install
6-
description: Installing LoRa Gateway OS on a Raspberry Pi.
6+
description: Installing ChirpStack Gateway OS on a Raspberry Pi.
77
---
88

99
# Raspberry Pi
@@ -23,6 +23,6 @@ concentrator shields:
2323

2424
### Installation
2525

26-
* Download one of the provided SD Card images from the [Raspberry Pi 3 images folder](http://artifacts.loraserver.io/downloads/lora-gateway-os/raspberrypi/raspberrypi3/{{< raspberrypi_raspberrypi3_version >}}/).
26+
* Download one of the provided SD Card images from the [Raspberry Pi 3 images folder](http://artifacts.chirpstack.io/downloads/chirpstack-gateway-os/raspberrypi/raspberrypi3/{{< raspberrypi_raspberrypi3_version >}}/).
2727
* Flash the SD Card image using for example [Etcher](https://www.balena.io/etcher/) on a SD Card.
28-
* Continue with [Using the LoRa Gateway OS images](/lora-gateway-os/use/).
28+
* Continue with [Using the ChirpStack Gateway OS images](/gateway-os/use/).

0 commit comments

Comments
 (0)