DevOps/helm-jamulus
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 4 Wiki Activity

readme updates

Browse Source
This commit is contained in:
Dana Harrison 2021-09-19 17:04:56 -04:00
parent 8838aa17ea
commit 71917d5dae
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -3,3 +3,14 @@ A Helm chart to deploy Jamulus Server into a LoadBalancer-enabled K8S environmen
## Usage ## 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 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.