Initial commit.

.gitignore

@@ -0,0 +1 @@
+book

Dockerfile-devel

@@ -0,0 +1,10 @@
+FROM rust:1.59.0-buster
+
+WORKDIR /chirpstack-docs
+
+
+RUN cargo install mdbook
+RUN cargo install mdbook-tera
+RUN cargo install mdbook-graphviz
+
+RUN apt-get update && apt-get install -y graphviz

Makefile

@@ -0,0 +1,9 @@
+build:
+	docker-compose run --rm chirpstack-docs mdbook clean
+	docker-compose run --rm chirpstack-docs mdbook build
+
+serve:
+	docker-compose run --rm --service-ports chirpstack-docs mdbook serve -n 0.0.0.0
+
+upload:
+	cd book && rsync -avzh . [email protected]:/var/www/chirpstack.io/docs/

book.toml

@@ -0,0 +1,27 @@
+[book]
+title = "ChirpStack open-source LoRaWAN® Network Server documentation"
+authors = []
+language = "en"
+multilingual = false
+src = "src"
+
+[output.html]
+no-section-label = true
+additional-css = ["theme/css/chirpstack.css"]
+git-repository-url = "https://github.com/chirpstack/chirpstack-docs"
+git-repository-icon = "fa-github"
+edit-url-template = "https://github.com/chirpstack/chirpstack-docs/edit/master/{path}"
+
+[output.html.print]
+enable = false
+
+[output.html.fold]
+enable = true
+level = 0
+
+[preprocessor.tera]
+command = "mdbook-tera --json ./src/context.json"
+
+[preprocessor.graphviz]
+command = "mdbook-graphviz"
+

docker-compose.yml

@@ -0,0 +1,9 @@
+services:
+  chirpstack-docs:
+    build:
+      context: .
+      dockerfile: Dockerfile-devel
+    ports:
+      - 3000:3000
+    volumes:
+      - ./:/chirpstack-docs

src/SUMMARY.md

@@ -0,0 +1,34 @@
+# Summary
+
+- [Introduction](./index.md)
+- [Architecture](./architecture.md)
+- [v3 to v4 migration](./v3-v4-migration.md)
+
+---
+
+# ChirpStack
+
+- [Changelog](./chirpstack/changelog.md)
+- [Configuration](./chirpstack/configuration.md)
+- [Downloads](./chirpstack/downloads.md)
+- [Features](./chirpstack/features/index.md)
+  - [Multi-region](./chirpstack/features/multi-reagion.md)
+
+# ChirpStack Gateway OS
+
+- [Introduction](./gateway-os/index.md)
+- [Image types](./gateway-os/image-types.md)
+- [Changelog](./gateway-os/changelog.md)
+- [Downloads](./gateway-os/downloads.md)
+- [Guides](./gateway-os/guides/index.md)
+  - [Getting started](./gateway-os/guides/getting-started.md)
+  - [Node-RED](./gateway-os/guides/node-red.md)
+- [Use](./gateway-os/use/index.md)
+  - [Configuration](./gateway-os/use/gateway-config.md)
+  - [Log files](./gateway-os/use/log-files.md)
+  - [Monitoring](./gateway-os/use/monitoring.md)
+  - [Modifying files](./gateway-os/use/modifying-files.md)
+  - [Software update](./gateway-os/use/software-update.md)
+- [Contribute & source](./gateway-os/contribute.md)
+
+---

src/architecture.md

@@ -0,0 +1,76 @@
+# Architecture
+
+A typical ChirpStack deployment has the following architecture:
+
+```dot process
+digraph G {
+	node [shape=record,fontsize="10"];
+	edge [fontsize="10"];
+	fontsize="10";
+
+	subgraph cluster_0 {
+		style=filled;
+		color="#bbdefb";
+		node [style=filled,color="#e3f2fd"];
+
+		"chirpstack" -> "pub-sub" [dir="both",label="MQTT"];
+		"chirpstack-gateway-bridge-cloud" -> "pub-sub" [dir="both" label="MQTT"];
+
+		"chirpstack" [label="ChirpStack"];
+		"pub-sub" [label="MQTT broker"];
+		"chirpstack-gateway-bridge-cloud" [label="ChirpStack Gateway Bridge"];
+
+		label = "Cloud / server / VM";
+	}
+
+	subgraph cluster_1 {
+		style=filled;
+		color="#bbdefb";
+		node [style=filled,color="#e3f2fd"];
+		label="LoRa® Gateway";
+
+		"chirpstack-gateway-bridge-gw" -> "pub-sub" [label="MQTT",dir="both"];
+		"chirpstack-gateway-bridge-gw" [label="Packet Forwarder +\nChirpStack Gateway Bridge"];
+	}
+
+
+	subgraph cluster_2 {
+		style=filled;
+		color="#bbdefb";
+		node [style=filled,color="#e3f2fd"];
+		label="LoRa® Gateway";
+
+		"packet-forwarder-gw2" -> "chirpstack-gateway-bridge-cloud" [label="UDP",dir="both"];
+		"packet-forwarder-gw2" [label="Packet Forwarder"];
+	}
+
+	subgraph cluster_3 {
+		style=filled;
+		color="#bbdefb";
+		node [style=filled,color="#e3f2fd"];
+		label="LoRa® Gateway";
+
+		"packet-forwarder-gw3" -> "chirpstack-gateway-bridge-cloud" [label="Websockets",dir="both"];
+		"packet-forwarder-gw3" [label="Basics Station"];
+	}
+
+	subgraph cluster_5 {
+		style=filled;
+		color="#bbdefb";
+		node [style=filled,color="#e3f2fd"];
+		label="Integrations";
+
+		"http-int" [label="HTTP"];
+		"mqtt-int" [label="MQTT"];
+		"other-int" [label="Etc ..."];
+	}
+
+
+	"chirpstack" -> "http-int";
+	"chirpstack" -> "mqtt-int";
+	"chirpstack" -> "other-int";
+
+	"as-api-client" -> "chirpstack" [label="gRPC"];
+	"as-api-client" [label="API client"];
+}
+```