Include REST API in example.

This commit is contained in:
Orne Brocaar 2022-08-12 09:50:39 +01:00
parent 4614890861
commit 751b139d41
2 changed files with 18 additions and 1 deletions

View File

@ -17,7 +17,8 @@ but keep in mind that for production usage it might need modifications.
## Configuration ## Configuration
This setup is pre-configured for all regions. You can either connect a ChirpStack Gateway Bridge This setup is pre-configured for all regions. You can either connect a ChirpStack Gateway Bridge
instance (v3.14.0+) to the MQTT broker (port 1883). Please note that: instance (v3.14.0+) to the MQTT broker (port 1883) or connect a Semtech UDP Packet Forwarder.
Please note that:
* You must prefix the MQTT topic with the region * You must prefix the MQTT topic with the region
Please see the region configuration files in the `configuration/chirpstack` for a list Please see the region configuration files in the `configuration/chirpstack` for a list
@ -60,3 +61,11 @@ $ docker-compose up
After all the components have been initialized and started, you should be able After all the components have been initialized and started, you should be able
to open http://localhost:8080/ in your browser. to open http://localhost:8080/ in your browser.
##
The example includes the [ChirpStack REST API](https://github.com/chirpstack/chirpstack-rest-api).
You should be able to access the UI by opening http://localhost:8090 in your browser.
**Note:** It is recommended to use the [gRPC](https://www.chirpstack.io/docs/chirpstack/api/grpc.html)
interface over the [REST](https://www.chirpstack.io/docs/chirpstack/api/rest.html) interface.

View File

@ -24,6 +24,14 @@ services:
depends_on: depends_on:
- mosquitto - mosquitto
chirpstack-rest-api:
image: chirpstack/chirpstack-rest-api:4.0.0-rc.1
command: --server chirpstack:8080 --bind 0.0.0.0:8090 --insecure
ports:
- 8090:8090
depends_on:
- chirpstack
postgres: postgres:
image: postgres:14-alpine image: postgres:14-alpine
volumes: volumes: