Document exposing the gateway on a different port
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 67
- Forks
- 94
- Avg merge
- 5h 51m
- Merged PRs (30d)
- 1
Description
Proposed change
The docs should show developers how to change the public port of the gateway. In both swarm and k8s this is not very complicated. We should warn users about exposing it publically, but for developers testing OpenFaaS they might have port conflicts on their local systems.
The docs should identify use cases and which files would need to be modified.
Context
Several users have asked about this in Slack. Documenting this will simplify the developer experience.
-
Operating System and version (e.g. Linux, Windows, MacOS):
-
Link to your project or a code example to reproduce issue:
-
Please also follow the troubleshooting guide and paste in any other diagnostic information you have:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with guide/troubleshooting.md and locate the existing Swarm and Kubernetes gateway deployment documentation. Document the relevant files to edit, explain how developers can change the public port, cover local port-conflict use cases, and warn about public exposure; done means both deployment methods and the security warning are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, kubernetes
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100