[Bug]: No documentation for new network public key feature
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 8.3k
- Forks
- 1.3k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 37
Description
Version of OpenTTD
15.0-pre
Expected result
Nice comprehensive documentation about how to securely set up a server that only allows certain people in.
Actual result
Network passwords were removed in https://github.com/OpenTTD/OpenTTD/pull/12323 & https://github.com/OpenTTD/OpenTTD/pull/12300 et al., and people are going to become confused. We need some documentation that we can point at that explains the new methods (and possibly even why they're better)
Steps to reproduce
- Host a server in old versions
- Upgrading hosting to 15.0
- Become confused
- Post issue on bug tracker
- Get flamed
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
Read the network-password removal changes in PRs 12323 and 12300, then locate the existing server setup and networking documentation. Document the new public-key-based methods, secure access setup, and why the old password approach changed; done means users upgrading to 15.0 can follow the guidance to restrict server access.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation, networking, security
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100