Feature/docker setup

[computamike]

Hi @edent - this is my PR for #332 - I tried rebasing a few times and it seems to just have bloated my commits. Squashing should resolve this when merging in - sorry for the inconvenience. There's only 17 files that I have added to the project - so hopefully they should be easy enough to review.

I have tried to put pretty much everything into a docker_config folder - so much of the changes you'll see are in there.

I also added a brief "how to" guide for setting up a development environment using docker - and popped the documentation resources into the docs folder - I had an idea that maybe if the need for more docs grew you'd be able to harness GitHub pages, and serve the documentation from the docs folder - This was something that @backache was mentioning in #324.

I have gone with MariaDB as the database store - reading through the docs on there are some pages the reference MySQL and MariaDB -

• CONTRIBUTING references both MariaDB and MySQL in the same document -
• README mentions MySQL

Totally happy to replace this with MySQL if required.

Was wondering whether to do a supporting YouTube video (How to download the repo, set up Docker and start debugging) - let me know if that is something useful, and if I can get it done, I can send it along.

I think that's everything - hope this is ok.

[computamike]

I added this launch file in - so if you were using VSCode then you should be able to debug OB using that.

[edent]

I'll be honest - I've never used Docker in anger. So I've no idea if this will work. If you're happy with this - and happy to keep maintaining it, then I'm happy to merge :-)

[Dan-Q]

The docker configuration isn't in the root directory, so this doesn't work for me. Instead, I have to run e.g.:

docker compose -f docker_config/docker-compose.yml up -d

Is that what you intended, perhaps? Or are you running e.g. cd docker_config && docker compose up -d?

Either way, might be worth documenting exactly!

[MikeHingley22]

Thanks @Dan-Q - I'll make sure it's documented exactly. You're right - the docs should reference the docker_config folder - or the compose file should move to the root. I think it's probably ok to just update the docs.

My intention has been to be able to check out the code, run a docker-compose up -d - so that the barrier to run it locally isn't massive