From 71917d5daef6872df799dc5886003eae1507ca51 Mon Sep 17 00:00:00 2001 From: Dana Harrison Date: Sun, 19 Sep 2021 17:04:56 -0400 Subject: [PATCH] readme updates --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index f6f8b38..4e4453d 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,14 @@ A Helm chart to deploy Jamulus Server into a LoadBalancer-enabled K8S environmen ## Usage This particular service is set up in an environment with LoadBalancer enabled, so that the Jamulus server can have its own IP assigned. At home, I'm using metallb and highly recommend it. You can just expose the port if you'd rather do without it. + +This implementation just logs to emptyDir by default, but you can mount a directory for logging if needed. + +### Values YAML + +containerPort: the port on which Jamulus will run and the port will be exposed to the service +maxUsers: the maximum number of users able to connect to Jamulus at once +serverMessage: the message shown to the user when connecting to the Jamulus server + +## Credits +Big thanks to [grundic](https://github.com/grundic) for their work on building out the Docker image.