Skip to content

Commit a35dfec

Browse files
authored
Docker Compose setup example. (#8)
Co-authored-by: Bones <[email protected]>
1 parent 2e1f252 commit a35dfec

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.md

+31-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ bind="0.0.0.0:1700"
115115
# # This backend is for uplink only. It is not able to send data
116116
# # back to the gateways.
117117
# uplink_only=false
118-
#
118+
#
119119
# # Gateway IDs
120120
# #
121121
# # The Gateway IDs to forward data for.
@@ -125,6 +125,36 @@ bind="0.0.0.0:1700"
125125
# ]
126126
```
127127

128+
## Example docker compose setup
129+
130+
If you built the docker image for the packet multiplexer as above and wish to
131+
run it through docker compose create a suitable location for volumes and
132+
configfile to reside.
133+
134+
```
135+
mkdir chirpstack-packet_multiplexer/config
136+
touch chirpstack-packet_multiplexer/config/chirpstack-packet-multiplexer.toml
137+
```
138+
139+
Save your template in the following just created location below. Edit as required
140+
for multiplexer and backends.
141+
```chirpstack-packet_multiplexer/config/chirpstack-packet-multiplexer.toml```
142+
143+
Example docker-compose
144+
```
145+
version: "3"
146+
services:
147+
chirpstack-packet-multiplexer:
148+
image: chirpstack-packet-multiplexer:latest
149+
ports:
150+
- 1700:1700/udp
151+
volumes:
152+
- ./:/chirpstack-packet-multiplexer
153+
- ./config/chirpstack-packet-multiplexer.toml:/etc/chirpstack-packet-multiplexer/chirpstack-packet-multiplexer.toml:ro
154+
```
155+
To run...
156+
```docker-compose up```
157+
128158
## Changelog
129159

130160
### v3.1.0

0 commit comments

Comments
 (0)