target
Exposed ports don't appear to be documented
Report
3 ports are exposed by the flottbot dockerfile:
EXPOSE 8080 3000 4000
None of them are explicitly mentioned in the documentation (e.g. port 8080 is used for X). #56 mentions that these are for prometheus, slack events, and slack interactions api receiver, but doesn't mention which port is intended for which purpose.
What did you do?
Read docs, read the Dockerfile, read the example.
The config-example/bot.yml says:
# true: enables prometheus metrics on localhost port 8080
prommetric.go says:
go http.ListenAndServe(":8080", promRouter)
which indicates that it listens on INADDR_ANY.
helper.go listens on :3000 and remote.go listens on :4000. Is there any reason these aren't config options, and/or aren't documented?
What did you expect to happen?
Ports named and documented in configurations, with the defaults as defaults.
What happened instead?
No documentation.
Your Environment
Please complete the following information):
- Flottbot version: github HEAD
- OS: N/A
- OS version: N/A
- Bot YAML: N/A
- Rule YAML: N/A
I'm happy to work up a PR if what I'm asking about seems reasonable.
Thanks for the issue. An oversight on our part. This definitely is something on the radar and related to #56 as you pointed out. I have edited that issue include some of the info and call out the requirement to make it configurable. If you want to make an interim PR to the docs site and/or in this repo where applicable to call the current setup out, we'd be happy to merge it.
