zoraxy icon indicating copy to clipboard operation
zoraxy copied to clipboard

Update README.md

Open NeoMod opened this issue 1 year ago • 4 comments

Updated the Docker Compose file to reflect the proper way of handling environment variables, especially since v. 3.0.9 introduces a breaking change compared to the composing file's previous example.

NeoMod avatar Jul 22 '24 14:07 NeoMod

the PORT: "8005" format is equivalent to the - PORT=8005 and, in my opinion, the former looks much better so I would like to keep that

PassiveLemon avatar Jul 22 '24 16:07 PassiveLemon

@PassiveLemon I wouldn't have suggested it If I hadn't noticed that using the former format lead to the loss of functionality of the container. Anyway, more tests are underway since I believe I found a bug with that particular variable exposed (docker compose + portainer)

NeoMod avatar Jul 22 '24 17:07 NeoMod

@PassiveLemon Also, that would not explain the presence of this note in the docker-compose file in the repository:

image

Why making a clear point about not using the colon in the port flag, if it doesn't cause an issue? I think this should be re-evaluated.

NeoMod avatar Jul 22 '24 17:07 NeoMod

That is noted for usage with Docker run, hence the use of CLI operators in the table above it but I can add a note for Docker compose usage too, thanks for catching that

Why making a clear point about not using the colon in the port flag, if it doesn't cause an issue?

Including a colon does cause issues because of how Zoraxy uses the port argument internally. When the colon is included, the healthcheck command would be nc -vz 127.0.0.1 :8000 which is incorrect. However, when the PORT variable is passed to Zoraxy as a CLI argument, the colon is prepended: -port=:${PORT}

I wouldn't have suggested it If I hadn't noticed that using the former format lead to the loss of functionality of the container.

I'm not exactly sure how the format of the environment attribute would lead to a loss of functionality. What functionality is lost? Please do update us about that

PassiveLemon avatar Jul 22 '24 17:07 PassiveLemon

Since this is now outdated, I'm going to close it

PassiveLemon avatar Sep 14 '24 05:09 PassiveLemon