Skip to content

Commit cae6e5d

Browse files
brocaarbrocaar
committed
Rename to ChirpStack Gateway Bridge.
1 parent 8e4a50c commit cae6e5d

File tree

124 files changed

+761
-884
lines changed

Some content is hidden

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

124 files changed

+761
-884
lines changed

‎.circleci/config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88
- checkout
99
- run:
1010
name: run tests
11-
command: docker-compose run --rm gatewaybridge make test
11+
command: docker-compose run --rm chirpstack-gateway-bridge make test
1212

1313
deploy:
1414
machine:
@@ -18,10 +18,10 @@ jobs:
1818
- checkout
1919
- run:
2020
name: compile distributable binaries
21-
command: docker-compose run --rm gatewaybridge make dist
21+
command: docker-compose run --rm chirpstack-gateway-bridge make dist
2222
- run:
2323
name: upload binaries to s3
24-
command: aws s3 sync dist/upload s3://builds.loraserver.io/lora-gateway-bridge
24+
command: aws s3 sync dist/upload s3://builds.loraserver.io/chirpstack-gateway-bridge
2525

2626
workflows:
2727
version: 2

‎.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "docs/themes/chirpstack-hugo-theme"]
2+
path = docs/themes/chirpstack-hugo-theme
3+
url = git@github.com:brocaar/chirpstack-hugo-theme.git

‎.goreleaser.yml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
project_name: lora-gateway-bridge
1+
project_name: chirpstack-gateway-bridge
22

33
builds:
4-
- main: cmd/lora-gateway-bridge/main.go
5-
binary: lora-gateway-bridge
4+
- main: cmd/chirpstack-gateway-bridge/main.go
5+
binary: chirpstack-gateway-bridge
66
goos:
77
- windows
88
- darwin
@@ -24,20 +24,21 @@ release:
2424
disable: true
2525

2626
nfpm:
27-
vendor: LoRa Server project
28-
homepage: https://www.loraserver.io/
27+
vendor: ChirpStack
28+
homepage: https://www.chirpstack.io/
2929
maintainer: Orne Brocaar <info@brocaar.com>
30-
description: LoRa Gateway Bridge
30+
description: ChirpStack Gateway Bridge
3131
license: MIT
3232
formats:
3333
- deb
3434
bindir: /usr/bin
3535
files:
36-
"packaging/files/lora-gateway-bridge.rotate": "/etc/logrotate.d/lora-gateway-bridge"
37-
"packaging/files/lora-gateway-bridge.init": "/usr/lib/lora-gateway-bridge/scripts/lora-gateway-bridge.init"
38-
"packaging/files/lora-gateway-bridge.service": "/usr/lib/lora-gateway-bridge/scripts/lora-gateway-bridge.service"
36+
"packaging/files/chirpstack-gateway-bridge.rotate": "/etc/logrotate.d/chirpstack-gateway-bridge"
37+
"packaging/files/chirpstack-gateway-bridge.init": "/usr/lib/chirpstack-gateway-bridge/scripts/chirpstack-gateway-bridge.init"
38+
"packaging/files/chirpstack-gateway-bridge.service": "/usr/lib/chirpstack-gateway-bridge/scripts/chirpstack-gateway-bridge.service"
3939
config_files:
40-
"packaging/files/lora-gateway-bridge.toml": "/etc/lora-gateway-bridge/lora-gateway-bridge.toml"
40+
"packaging/files/chirpstack-gateway-bridge.toml": "/etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml"
4141
scripts:
42+
preinstall: "packaging/scripts/pre-install.sh"
4243
postinstall: "packaging/scripts/post-install.sh"
4344
postremove: "packaging/scripts/post-remove.sh"

‎CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
There are a couple of ways to get involved:
44

55
* Join the discussions:
6-
* LoRa Server project forum [https://forum.loraserver.io/](https://forum.loraserver.io/)
7-
* Report bugs or make feature-requests by opening an issue at [https://github.com/brocaar/lora-gateway-bridge/issues](https://github.com/brocaar/lora-gateway-bridge/issues)
6+
* LoRa Server project forum [https://community.chirpstack.io/](https://community.chirpstack.io/)
7+
* Report bugs or make feature-requests by opening an issue at [https://github.com/brocaar/chirpstack-gateway-bridge/issues](https://github.com/brocaar/chirpstack-gateway-bridge/issues)
88
* Help fixing issues or improve documentation by creating pull-requests
99

1010

‎Dockerfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
FROM golang:1.12-alpine AS development
22

3-
ENV PROJECT_PATH=/lora-gateway-bridge
3+
ENV PROJECT_PATH=/chirpstack-gateway-bridge
44
ENV PATH=$PATH:$PROJECT_PATH/build
55
ENV CGO_ENABLED=0
66
ENV GO_EXTRA_BUILD_ARGS="-a -installsuffix cgo"
@@ -18,5 +18,5 @@ FROM alpine:latest AS production
1818

1919
WORKDIR /root/
2020
RUN apk --no-cache add ca-certificates
21-
COPY --from=development /lora-gateway-bridge/build/lora-gateway-bridge .
22-
ENTRYPOINT ["./lora-gateway-bridge"]
21+
COPY --from=development /chirpstack-gateway-bridge/build/chirpstack-gateway-bridge .
22+
ENTRYPOINT ["./chirpstack-gateway-bridge"]

‎Dockerfile-devel

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
FROM golang:1.12-alpine
22

3-
ENV PROJECT_PATH=/lora-gateway-bridge
3+
ENV PROJECT_PATH=/chirpstack-gateway-bridge
44
ENV PATH=$PATH:$PROJECT_PATH/build
55
ENV CGO_ENABLED=0
66
ENV GO_EXTRA_BUILD_ARGS="-a -installsuffix cgo"

‎LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2018 Orne Brocaar
3+
Copyright (c) 2019 Orne Brocaar
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ VERSION := $(shell git describe --always |sed -e "s/^v//")
55
build:
66
@echo "Compiling source"
77
@mkdir -p build
8-
go build $(GO_EXTRA_BUILD_ARGS) -ldflags "-s -w -X main.version=$(VERSION)" -o build/lora-gateway-bridge cmd/lora-gateway-bridge/main.go
8+
go build $(GO_EXTRA_BUILD_ARGS) -ldflags "-s -w -X main.version=$(VERSION)" -o build/chirpstack-gateway-bridge cmd/chirpstack-gateway-bridge/main.go
99

1010
clean:
1111
@echo "Cleaning up workspace"
@@ -40,7 +40,7 @@ dev-requirements:
4040
# shortcuts for development
4141

4242
serve: build
43-
./build/lora-gateway-bridge
43+
./build/chirpstack-gateway-bridge
4444

4545
run-compose-test:
4646
docker-compose run --rm gatewaybridge make test

‎README.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
# LoRa Gateway Bridge
1+
# ChirpStack Gateway Bridge
22

3-
[![CircleCI](https://circleci.com/gh/brocaar/lora-gateway-bridge.svg?style=svg)](https://circleci.com/gh/brocaar/lora-gateway-bridge)
3+
[![CircleCI](https://circleci.com/gh/brocaar/chirpstack-gateway-bridge.svg?style=svg)](https://circleci.com/gh/brocaar/chirpstack-gateway-bridge)
44

5-
LoRa Gateway Bridge is a service which converts LoRa packet-forwarder protocols
6-
into a LoRa Server [common protocol](https://github.com/brocaar/loraserver/blob/master/api/gw/gw.proto) (JSON and Protobuf).
7-
This project is part of the [LoRa Server](https://github.com/brocaar/loraserver)
8-
project.
5+
ChirpStack Gateway Bridge is a service which converts LoRa<sup>&reg;</sup> Packet Forwarder protocols
6+
into a ChirpStack Network Server [common data-format](https://github.com/brocaar/chirpstack-network-server/blob/master/api/gw/gw.proto) (JSON and Protobuf).
7+
This component is part of the ChirpStack open-source LoRaWAN<sup>&reg;</sup> Network Server stack.
98

109
## Backends
1110

@@ -23,33 +22,32 @@ The following integrations are provided:
2322

2423
## Architecture
2524

26-
![architecture](https://docs.loraserver.io/img/architecture.png)
25+
![architecture](https://www.chirpstack.io/img/graphs/architecture.png)
2726

2827
### Component links
2928

30-
* [LoRa Gateway Bridge](https://www.loraserver.io/lora-gateway-bridge)
31-
* [LoRa Gateway Config](https://www.loraserver.io/lora-gateway-bridge/install/config)
32-
* [LoRa Server](https://www.loraserver.io/loraserver)
33-
* [LoRa App Server](https://www.loraserver.io/lora-app-server)
29+
* [ChirpStack Gateway Bridge](https://www.chirpstack.io/gateway-bridge/)
30+
* [ChirpStack Network Server](https://www.chirpstack.io/network-server/)
31+
* [ChirpStack Application Server](https://www.chirpstack.io/application-server/)
3432

3533
## Links
36-
****
37-
* [Downloads](https://www.loraserver.io/lora-gateway-bridge/overview/downloads/)
38-
* [Docker image](https://hub.docker.com/r/loraserver/lora-gateway-bridge/)
39-
* [Documentation](https://www.loraserver.io/lora-gateway-bridge/)
40-
* [Building from source](https://www.loraserver.io/lora-gateway-bridge/community/source/)
41-
* [Contributing](https://www.loraserver.io/lora-gateway-bridge/community/contribute/)
34+
35+
* [Downloads](https://www.chirpstack.io/gateway-bridge/overview/downloads/)
36+
* [Docker image](https://hub.docker.com/r/chirpstack/chirpstack-gateway-bridge/)
37+
* [Documentation](https://www.chirpstack.io/gateway-bridge/)
38+
* [Building from source](https://www.chirpstack.io/gateway-bridge/community/source/)
39+
* [Contributing](https://www.chirpstack.io/gateway-bridge/community/contribute/)
4240
* Support
43-
* [Support forum](https://forum.loraserver.io)
44-
* [Bug or feature requests](https://github.com/brocaar/lora-gateway-bridge/issues)
41+
* [Community forum](https://community.chirpstack.io)
42+
* [Bug or feature requests](https://github.com/brocaar/chirpstack-gateway-bridge/issues)
4543

4644
## Sponsors
4745

48-
[![CableLabs](https://www.loraserver.io/img/sponsors/cablelabs.png)](https://www.cablelabs.com/)
49-
[![SIDNFonds](https://www.loraserver.io/img/sponsors/sidn_fonds.png)](https://www.sidnfonds.nl/)
50-
[![acklio](https://www.loraserver.io/img/sponsors/acklio.png)](http://www.ackl.io/)
46+
[![CableLabs](https://www.chirpstack.io/img/sponsors/cablelabs.png)](https://www.cablelabs.com/)
47+
[![SIDNFonds](https://www.chirpstack.io/img/sponsors/sidn_fonds.png)](https://www.sidnfonds.nl/)
48+
[![acklio](https://www.chirpstack.io/img/sponsors/acklio.png)](http://www.ackl.io/)
5149

5250
## License
5351

54-
LoRa Gateway Bridge is distributed under the MIT license. See
55-
[LICENSE](https://github.com/brocaar/lora-gateway-bridge/blob/master/LICENSE).
52+
ChirpStack Gateway Bridge is distributed under the MIT license. See
53+
[LICENSE](https://github.com/brocaar/chirpstack-gateway-bridge/blob/master/LICENSE).

‎cmd/lora-gateway-bridge/cmd/configfile.go renamed to ‎cmd/chirpstack-gateway-bridge/cmd/configfile.go

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"html/template"
55
"os"
66

7-
"github.com/brocaar/lora-gateway-bridge/internal/config"
7+
"github.com/brocaar/chirpstack-gateway-bridge/internal/config"
88
"github.com/pkg/errors"
99
"github.com/spf13/cobra"
1010
)
@@ -18,8 +18,8 @@ log_level = {{ .General.LogLevel }}
1818
# Filters.
1919
#
2020
# These can be used to filter LoRaWAN frames to reduce bandwith usage between
21-
# the gateway and LoRa Gateway Bride. Depending the used backend, filtering
22-
# will be performed by the Packet Forwarder or LoRa Gateway Bridge.
21+
# the gateway and ChirpStack Gateway Bride. Depending the used backend, filtering
22+
# will be performed by the Packet Forwarder or ChirpStack Gateway Bridge.
2323
[filters]
2424
2525
# NetIDs filters.
@@ -102,13 +102,13 @@ type="{{ .Backend.Type }}"
102102
# TLS certificate and key files.
103103
#
104104
# When set, the websocket listener will use TLS to secure the connections
105-
# between the gateways and LoRa Gateway Bridge (optional).
105+
# between the gateways and ChirpStack Gateway Bridge (optional).
106106
tls_cert="{{ .Backend.BasicStation.TLSCert }}"
107107
tls_key="{{ .Backend.BasicStation.TLSKey }}"
108108
109109
# TLS CA certificate.
110110
#
111-
# When configured, LoRa Gateway Bridge will validate that the client
111+
# When configured, ChirpStack Gateway Bridge will validate that the client
112112
# certificate of the gateway has been signed by this CA certificate.
113113
ca_cert="{{ .Backend.BasicStation.CACert }}"
114114
@@ -194,7 +194,7 @@ type="{{ .Backend.Type }}"
194194
# Payload marshaler.
195195
#
196196
# This defines how the MQTT payloads are encoded. Valid options are:
197-
# * protobuf: Protobuf encoding (this will become the LoRa Gateway Bridge v3 default)
197+
# * protobuf: Protobuf encoding
198198
# * json: JSON encoding (easier for debugging, but less compact than 'protobuf')
199199
marshaler="{{ .Integration.Marshaler }}"
200200
@@ -316,7 +316,7 @@ marshaler="{{ .Integration.Marshaler }}"
316316
317317
# Token expiration (symmetric key authentication).
318318
#
319-
# LoRa Gateway Bridge will generate a SAS token with the given expiration.
319+
# ChirpStack Gateway Bridge will generate a SAS token with the given expiration.
320320
# After the token has expired, it will generate a new one and trigger a
321321
# re-connect (only for symmetric key authentication).
322322
sas_token_expiration="{{ .Integration.MQTT.Auth.AzureIoTHub.SASTokenExpiration }}"
@@ -347,7 +347,7 @@ marshaler="{{ .Integration.Marshaler }}"
347347
348348
# Metrics stored in Prometheus.
349349
#
350-
# These metrics expose information about the state of the LoRa Gateway Bridge
350+
# These metrics expose information about the state of the ChirpStack Gateway Bridge
351351
# instance like number of messages processed, number of function calls, etc.
352352
[metrics.prometheus]
353353
# Expose Prometheus metrics endpoint.
@@ -360,7 +360,7 @@ marshaler="{{ .Integration.Marshaler }}"
360360
361361
# Gateway meta-data.
362362
#
363-
# The meta-data will be added to every stats message sent by the LoRa Gateway
363+
# The meta-data will be added to every stats message sent by the ChirpStack Gateway
364364
# Bridge.
365365
[meta_data]
366366
@@ -404,7 +404,7 @@ marshaler="{{ .Integration.Marshaler }}"
404404
# Executable commands.
405405
#
406406
# The configured commands can be triggered by sending a message to the
407-
# LoRa Gateway Bridge.
407+
# ChirpStack Gateway Bridge.
408408
[commands]
409409
# Example:
410410
# [commands.commands.reboot]
@@ -419,7 +419,7 @@ marshaler="{{ .Integration.Marshaler }}"
419419

420420
var configCmd = &cobra.Command{
421421
Use: "configfile",
422-
Short: "Print the LoRa Gateway Bridge configuration file",
422+
Short: "Print the ChirpStack Gateway Bridge configuration file",
423423
RunE: func(cmd *cobra.Command, args []string) error {
424424
t := template.Must(template.New("config").Parse(configTemplate))
425425
err := t.Execute(os.Stdout, config.C)

‎cmd/lora-gateway-bridge/cmd/root.go renamed to ‎cmd/chirpstack-gateway-bridge/cmd/root.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ import (
1111
"github.com/spf13/cobra"
1212
"github.com/spf13/viper"
1313

14-
"github.com/brocaar/lora-gateway-bridge/internal/config"
14+
"github.com/brocaar/chirpstack-gateway-bridge/internal/config"
1515
)
1616

1717
var cfgFile string // config file
1818
var version string
1919

2020
var rootCmd = &cobra.Command{
21-
Use: "lora-gateway-bridge",
22-
Short: "abstracts the packet_forwarder protocol into JSON over MQTT",
23-
Long: `LoRa Gateway Bridge abstracts the packet_forwarder protocol into JSON over MQTT
24-
> documentation & support: https://www.loraserver.io/lora-gateway-bridge
25-
> source & copyright information: https://github.com/brocaar/lora-gateway-bridge`,
21+
Use: "chirpstack-gateway-bridge",
22+
Short: "abstracts the packet_forwarder protocol into Protobuf or JSON over MQTT",
23+
Long: `ChirpStack Gateway Bridge abstracts the packet_forwarder protocol into Protobuf or JSON over MQTT
24+
> documentation & support: https://www.chirpstack.io/gateway-bridge/
25+
> source & copyright information: https://github.com/brocaar/chirpstack-gateway-bridge`,
2626
RunE: run,
2727
}
2828

@@ -90,10 +90,10 @@ func initConfig() {
9090
log.WithError(err).WithField("config", cfgFile).Fatal("error loading config file")
9191
}
9292
} else {
93-
viper.SetConfigName("lora-gateway-bridge")
93+
viper.SetConfigName("chirpstack-gateway-bridge")
9494
viper.AddConfigPath(".")
95-
viper.AddConfigPath("$HOME/.config/lora-gateway-bridge")
96-
viper.AddConfigPath("/etc/lora-gateway-bridge/")
95+
viper.AddConfigPath("$HOME/.config/chirpstack-gateway-bridge")
96+
viper.AddConfigPath("/etc/chirpstack-gateway-bridge/")
9797
if err := viper.ReadInConfig(); err != nil {
9898
switch err.(type) {
9999
case viper.ConfigFileNotFoundError:

‎cmd/lora-gateway-bridge/cmd/root_run.go renamed to ‎cmd/chirpstack-gateway-bridge/cmd/root_run.go

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ import (
99
log "github.com/sirupsen/logrus"
1010
"github.com/spf13/cobra"
1111

12-
"github.com/brocaar/lora-gateway-bridge/internal/backend"
13-
"github.com/brocaar/lora-gateway-bridge/internal/commands"
14-
"github.com/brocaar/lora-gateway-bridge/internal/config"
15-
"github.com/brocaar/lora-gateway-bridge/internal/filters"
16-
"github.com/brocaar/lora-gateway-bridge/internal/forwarder"
17-
"github.com/brocaar/lora-gateway-bridge/internal/integration"
18-
"github.com/brocaar/lora-gateway-bridge/internal/metadata"
19-
"github.com/brocaar/lora-gateway-bridge/internal/metrics"
12+
"github.com/brocaar/chirpstack-gateway-bridge/internal/backend"
13+
"github.com/brocaar/chirpstack-gateway-bridge/internal/commands"
14+
"github.com/brocaar/chirpstack-gateway-bridge/internal/config"
15+
"github.com/brocaar/chirpstack-gateway-bridge/internal/filters"
16+
"github.com/brocaar/chirpstack-gateway-bridge/internal/forwarder"
17+
"github.com/brocaar/chirpstack-gateway-bridge/internal/integration"
18+
"github.com/brocaar/chirpstack-gateway-bridge/internal/metadata"
19+
"github.com/brocaar/chirpstack-gateway-bridge/internal/metrics"
2020
)
2121

2222
func run(cmd *cobra.Command, args []string) error {
@@ -55,8 +55,8 @@ func setLogLevel() error {
5555
func printStartMessage() error {
5656
log.WithFields(log.Fields{
5757
"version": version,
58-
"docs": "https://www.loraserver.io/lora-gateway-bridge/",
59-
}).Info("starting LoRa Gateway Bridge")
58+
"docs": "https://www.chirpstack.io/gateway-bridge/",
59+
}).Info("starting ChirpStack Gateway Bridge")
6060
return nil
6161
}
6262

‎cmd/lora-gateway-bridge/cmd/version.go renamed to ‎cmd/chirpstack-gateway-bridge/cmd/version.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import (
88

99
var versionCmd = &cobra.Command{
1010
Use: "version",
11-
Short: "Print the LoRa Gateway Bridge version",
11+
Short: "Print the ChirpStack Gateway Bridge version",
1212
Run: func(cmd *cobra.Command, args []string) {
1313
fmt.Println(version)
1414
},

‎cmd/chirpstack-gateway-bridge/main.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
package main
2+
3+
import "github.com/brocaar/chirpstack-gateway-bridge/cmd/chirpstack-gateway-bridge/cmd"
4+
5+
var version string // set by the compiler
6+
7+
func main() {
8+
cmd.Execute(version)
9+
}

0 commit comments

Comments
 (0)