smui icon indicating copy to clipboard operation
smui copied to clipboard

Move docker-compose.yml into a /examples subdir, and add more?

Open epugh opened this issue 4 years ago • 5 comments

I've written up some docker-compose.yml scripts for both MS SQL Server and MySQL. Should we move our "quickstart" docker-compose.yml into an /examples and then add more examples?

I'm happy to do this if folks think it would be a good enhancement.

epugh avatar Mar 12 '21 13:03 epugh

I really like the suggestion as the docker-compose.yaml introduces just one possible quickstart solution for SMUI (another might be offered by https://github.com/querqy/chorus).

@mkr , @gunnarbusch : Any objections? Otherwise , I'd move the file.

pbartusch avatar Mar 20 '21 13:03 pbartusch

we could have /examples/docker-compose-mysql.yaml, /examples/docker-compose-with-openid.yaml etc....

epugh avatar Mar 20 '21 15:03 epugh

@epugh , cool idea. As docker-compose.yaml is a standard in the Docker universe I'd rather suggest something like:

/examples/smui+mysql/docker-compose.yaml maybe add something like: /examples/smui+postgres+openid/docker-compose.yaml in the future?

As there seems to be no objection from the authors ( @mkr , @gunnarbusch ) for any conflict , I will adjust the structure soon (and the corresponding documentation).

pbartusch avatar Mar 24 '21 11:03 pbartusch

Hi! It's a great idea to include multiple example setups in different docker-compose.yaml. @pbartusch You will need to modify the runE2ETests.sh since it's setting up an integration environment for the end-to-end tests.

gunnarbusch avatar Mar 24 '21 20:03 gunnarbusch

Thank you , @gunnarbusch , for highlighting the dependency to the end-to-end test. I see there should be no dependency from an (deployment relevant) end-to-end test towards an example docker-compose file.

Therefore, I tend to leave things as they are right now, and rather add examples to the querqy.org documentation.

@epugh , do you have an immanent example for docker setup , that deviates from the one provided (like for OpenID) , that would qualify for a first case to this scenario?

pbartusch avatar Mar 25 '21 09:03 pbartusch