openziti / ziti

The parent project for OpenZiti. Here you will find the executables for a fully zero trust, application embedded, programmable network @OpenZiti
https://openziti.io
Apache License 2.0
2.83k stars 159 forks source link

config var uniformity #1946

Open qrkourier opened 7 months ago

qrkourier commented 7 months ago

The inconsistency between these names is stumbling block for learners:

A minimal solution would be to introduce ZITI_ROUTER_ADVERTISED_ADDRESS as a replacement for ZITI_ROUTER_PORT while continuing to allow ZITI_ROUTER_PORT to function as an alias for the new var.

My personal preference is less minimal and aims for slightly improved aesthetics by shortening the other three, which are still unambiguous now that we're prescribing a single address and port as a best practice (thanks, ALPN):

qrkourier commented 4 months ago

The BrowZer bootstrapper introduces a pair of variables we could adopt here to solve this: