search

smallstep / hello-mtls

:wave: Docs demonstrating mutual TLS configurations in various technologies
Apache License 2.0
97 stars 26 forks source link

Standardize port numbers? #26

Closed alanchrt closed 5 years ago

alanchrt commented 5 years ago

@sourishkrout An item for discussion I noticed after reviewing the golang doc.

Should we standardize the server port number across all docs? For example, the nginx doc suggests binding :443, and the curl doc connects over bare domain (:443). But, go binds to :9443 and the client requests from :9443.

So, if in the process of going through a tutorial or onboarding flow, someone selects nginx as the server and go as the client, they'll be told to listen on :443 but make a request to the server at :9443. Or if they do go server and curl client, it's the opposite.

Any ideas? Seems like :9443 could work across the board without needing superuser privileges, but it's pretty awkward to configure nginx or some other thing that's obviously a web server on that port.

Or maybe we somehow provide a way (maybe in config.yaml) for docs that offer servers to also specify the port they bind to, then use a {{ port }} variable in client docs to feed in the port from the configured server?

alanchrt commented 5 years ago

Looking at it so far, and the only one not using :9443 is Nginx. It feels a little weird to have it not bind :443 since it's a production front-facing server, but maybe I bite the bullet for now and just make it :9443 so docs make sense all together? Then come back around later and do something smarter?

alanchrt commented 5 years ago

Addressed this with the addition of server_port to config.yaml!