Skip to content

Commit 422b5e2

Browse files
committed
add docs, add to changes.md
1 parent 42d9a8f commit 422b5e2

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,12 @@ Only non-TLS channels (`SASL_PLAINTEXT`) are currently supported.
6767
The SASL mechanism can be specified as part of the username/broker string as follows: `sasl_mechanism\username@broker:port/topic`.
6868
Example: `SCRAM-SHA-256\alice@10.123.123.1:9092/topic`.
6969

70+
### Running in container
71+
To build the forwarder for use within a container, use `docker build . --tag forwarder:latest`.
72+
73+
To use the container run `docker run -it forwarder:latest` followed by your options ie.
74+
`docker run -it forwarder:latest --config-topic mybroker:9092/configTopic . . . `
75+
7076
## Configuring EPICS PVs to be forwarded
7177

7278
Adding or removing PVs to be forwarded is done by publishing configuration change messages to the configuration

changes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* Adopt pip-tools to manage requirements.txt files
77
* Refactor statistics reporter to support dynamically added metrics
88
* Add latency and per-PV graphite metrics
9+
* Add containerfile
910

1011
## v2.1.0
1112

0 commit comments

Comments
 (0)