Support portainer

[zastrixarundell]

This PR basically just allows for the repo to be used in portainer.

Explained functionality: Create docker compose file specific for portainer. This file needs to be setup in the repository, or the users need to create their own forks of this project and maintain it. If an official image were published on an OCI repository there would be no need for this PR.

Notes:

• 8080 is used in healthchecks so I've hardcoded the internal port to 8080, $PORT now affects only the host port.

[zastrixarundell]

REDIS_URI can be setup in the example file to (and the docker-compose.yml file) to be already set at redis:6379, no?

[D3SOX]

I think it's cleaner for Portainer setups to have it as

env_file:
  - stack.env

instead of duplicating a bunch of variables.
Then one should add those environment variables inside Portainer under the compose editor (it uses stack.env as file name)
The easiest way for that is to enable the advanced editor and just paste the content of .env.example

[zastrixarundell]

I mean that is a solution as well for it. But I'm not sure if it'll work well for portainer as then ports aren't defined and network isn't set as host, so this might be a better solution?

[D3SOX]

Like this

(Just using Web editor for showcasing it here, this way it wouldn't work as it can't build the image but when you use it as a git repository stack it should work)

[zastrixarundell]

Yeah yeah we could add stack.env into the docker-compose.yml file and make it the default one. Then the documentation should be updated, but I'm also not really up for doing that. It would break the current deployments for other users as stack.env wouldn't be present.

This way with duplicating the variables in compose file:

• The variables have their own context in the file so you don't have to look at other files
• A bit more universal as it's not putting any hard requirements

I would personally go with my implementation over stack.env but it's ultimately for the owner of the repo to decide. I'd really not like to want to have my own fork and maintain it so I can use vencloud...

Edit:

I would be okay if there's a way to set a soft dependency for the env file but I'm not sure if that's a thing.

[D3SOX]

Having a unified docker compose file for both standalone docker compose installations and Portainer is generally a bad idea imo.

[zastrixarundell]

Oh! I didn't think of that honestly! That's a good idea! I'll go make a docker compose file specifically for portainer without modifying the old docker-compose.yml, I forgot it doesn't need to be exactly docker-compose.yml and that the end-user can specify which compose file should be used.

[zastrixarundell]

Just as an FYI, this PR isn't ready as-is. The documentation for portainer needs to be added. I'll write the documentation if the PR becomes approved.

[zastrixarundell]

Hm maybe default values should be put in these lines:

Vencloud/globals/globals.go

Lines 11 to 12 in 477392d

	HOST = os.Getenv("HOST")
	PORT = os.Getenv("PORT")

Let's say 8080 for PORT and 127.0.0.1 for HOST.

With this function:

func getEnv(key, fallback string) string {
    if value, ok := os.LookupEnv(key); ok {
        return value
    }
    return fallback
}

Because the healthcheck is working on port 8080:

Vencloud/Dockerfile

Line 17 in 477392d

HEALTHCHECK --interval=15s --timeout=3s CMD curl -f http://localhost:8080/v1/ || exit 1

Then there would be no reason to define the host and port in the docker-compose.yml.

[Vendicated]

can you explain why this is necessary? it seems just the same as the normal docker-compose file, other than renaming .env to stack.env and adding

environment:
    PORT: 8080
    HOST: 0.0.0.0
    REDIS_URI: redis:6379
ports:
    - ${PORT}:8080/tcp

why are these necessary? the three environment variables are already specified in .env and the port mapping via the override. Why the rename to stack.env?

[zastrixarundell]

Portainer demands the stack.env when deploying via git, it doesn't read the .env file. Sent from Proton Mail Android

…

-------- Original Message --------

On 6/23/24 4:28 PM, vee wrote: can you explain why this is necessary? it seems just the same as the normal docker-compose file, other than renaming .env to stack.env and adding environment : PORT : 8080 HOST : 0.0.0.0 REDIS_URI : redis:6379 ports : - ${PORT}:8080/tcp why are these necessary? the three environment variables are already specified in .env and PORT via the override. Why the rename to stack.env? — Reply to this email directly, [view it on GitHub](#22 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/AHGL5YJ3EHMT6R6BVEC6L3DZI3LPPAVCNFSM6AAAAABJYNJEXSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCOBVGAYTCNRSGY). You are receiving this because you authored the thread.Message ID: ***@***.***>

[Vendicated]

well thank you for the contribution, but i don't think there is any interest from our side to merge this. we don't know how portainer works and it seems unreasonable to have two almost duplicated configs, especially considering it seems to me as if this config force-overrides some values specified in .env, which is poor user experience. at this time, we also have no plans to publish to any container hub; it seems kinda pointless, considering it's just one simple git clone

it would probably be best for you to just keep this as your personal fork!