search

Renegade-Master / zomboid-dedicated-server

Linux based Docker image containing a Dedicated Server for Project Zomboid.
https://hub.docker.com/r/renegademaster/zomboid-dedicated-server
Other
173 stars 59 forks source link

Clarify environment/config variables #39

Closed Rene-Sackers closed 1 year ago

Rene-Sackers commented 2 years ago

I found the readme a little confusing regarding the environment variables. Especially the one labeled PUBLIC_SERVER.

There's a .ini variable called Public=true, but this environment variable modifies Open=true. I figured I'm not going to change the working of this, as it'll break any existing servers using it if they update.

I've added some extra description to the readme explaining that some .ini variables are overwritten at the start, and which environment variables affect which .ini variables.

Also the following was explained inversely:

PUBLIC_SERVER | If set to true only Pre-Approved/Allowed players can join the server

Setting PUBLIC_SERVER to true sets Open=true in ini, an in the ini it explains:

Clients may join without already having an account in the whitelist. If set to false, administrators must manually create username/password combos.

Related issue: https://github.com/Renegade-Master/zomboid-dedicated-server/issues/23

sonarcloud[bot] commented 2 years ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Rene-Sackers commented 1 year ago

@Renegade-Master can I get a review on this so we can maybe merge it? :)

Renegade-Master commented 1 year ago

Hey!

Thanks for the contribution! The only reason I have not really merged this yet, is that I am not sure I completely agree with some of the wording.

Also, I intend to rewrite the whole process I have here of configuring the server because it tends to overwrite what people do unexpectedly.

But, it could take me a while to get around to that, and your wording is good enough for now.

Rene-Sackers commented 1 year ago

Sorry for the late reply, my notification settings were messed up apparently 😟

Yeah I saw you were working on a different way of doing it, I know my changes aren't perfect, but hoped it'd help people in the meantime to clarify some things and prevent the pitfalls I encountered, until then.

Thx for the merge!