Skip to content

Commit 0680419

Browse files
Add some docs around dockerization (#6)
1 parent c243148 commit 0680419

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,19 @@ cargo run --features zenoh -- -t zenoh -a usubscription.local -v
5555
```
5656

5757
`up-subscription-cli` can be used with any uProtocol rust transport implementation - the available options are controlled as cargo features, refer to the definitions in the `[features]` section of up-subscription-cli `Cargo.toml`. Currently supported are [zenoh](https://github.com/eclipse-uprotocol/up-transport-zenoh-rust) and [socket](https://github.com/eclipse-uprotocol/up-transport-socket) transports, with [mqtt](https://github.com/eclipse-uprotocol/up-transport-mqtt5-rust) to follow as soon as they move over to using the up-rust release version from crates.io.
58+
59+
### Running with docker
60+
61+
The `up-subscription-cli` also can be built and run using docker and docker-compose. The top-level `Dockerfile` and `docker-compose.yaml` are provided for that purpose. `up-subscription-cli` can be provided with configuration parameters both via cli arguments, as well as environment variables. For reference on these, please refer to `docker-compose.yaml`. Please note that this configuration is provided mainly for demonstration purposes - for a production deployment, you want to revisit e.g. the network settings used by the container.
62+
63+
To build the container, in the project root run
64+
65+
```console
66+
docker build -t up-subscription .
67+
```
68+
69+
To run (and auto-build if required) the container, in the project root run
70+
71+
```console
72+
docker-compose up
73+
```

docker-compose.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,6 @@ services:
2323
- AUTHORITY=usubscription.local
2424
- TRANSPORT=zenoh
2525
- VERBOSE=true
26+
27+
# - SUBSCRIPTION_BUFFER=1024
28+
# - NOTIFICATION_BUFFER=1024

0 commit comments

Comments
 (0)