Repository navigation
docs: dev container and local database stack guide - #1486
Merged
Merged
Conversation
How to open the dev container, start the docker/ stack, connect Querya to each database (from the host and from inside the container, MySQL 8.4 TLS, Mongo auth source), run the test sections, e2e tests, the live MySQL test and the extension tester, plus known gaps and troubleshooting.
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
New guide
docs/dev-containers.md, linked fromdocs/README.mdand from Local dev databases indocs/getting-started.md.What it covers
docker/stack contain (files, post-create / post-start commands, ports, host requirements);devcontainerCLI and in Codespaces;.envoverrides, a table of ports, credentials and seeded data;localhostis the container itself, so the stack's network has to be joined (docker network connect querya-dev_default "$(hostname)") or the namespace shared; MySQL 8.4 needs Use SSL/TLS; MongoDB's auth source isadmin;Checked
Against the repository (
devcontainer.json,Dockerfile,docker-compose.yml,ci.yml,test_sections.sh, the live test) and against the running stack: ports, credentials, seeded collections / tables, MySQL'scaching_sha2_passworduser on 8.4, the compose network namequerya-dev_default, and the available image tags.Not checked
The guide's commands were not run inside a freshly built dev container: the X11 forwarding recipe,
docker network connectfrom inside it,--network container:$(hostname)and the Flutter checkout in Known gaps follow standard Docker and git behaviour but are worth a quick run by whoever uses the container first.