Run CMS locally with supporting services in Docker #38

kacperpONS · 2024-11-22T13:49:25Z

What is the context of this PR?

Added a way to run Wagtail outside of Docker with the supporting services still running in containers.

Changes made:

added convenience make commands
added an example .env file for the local config
added a new docker-compose for just the supporting services
added documentation in the README

How to review

Run the steps under Running Wagtail locally with supporting services in Docker and make sure that they work as expected.

Follow-up Actions

N/A

…docker-CMS-202

README.md

docker-compose.yml

Makefile

MebinAbraham

Good work, left some initial comments.

Makefile

docker-compose-dev.yml

.env-dev-example

Makefile

README.md

sanjeevz3009

Left some minor comments and suggestions. Pulled down the branch, tested everything locally and all seems to be good. LGTM!

Minor: Branch out of date!

README.md

…go-admin commands with make commands

Makefile

kacperpONS · 2024-12-02T13:07:36Z

For people who already have given this PR an approval:

I've noticed that if you were to follow the steps in the README about adding a .env file in your codebase, the old way of running everything in Docker would stop working.
This is caused by the fact that when you run the honcho start command inside the web container, honcho will pick up the local .env file, because it's mounted to the web container when it runs via docker-compose.
This would then lead to the DATABASE_URL and REDIS_URL env variables to be set to localhost, rather than to their containers and make the services not accessible to the web container.

I've talked to @zerolab and we've decided that in order to save time rather than try to work around this issue, we'll put a note about that in the README.

README.md

Co-authored-by: Jake Howard <[email protected]>

README.md

Makefile

README.md

Makefile

README.md

…in dev-init command

README.md

nehakerung · 2024-12-03T09:28:27Z

LGTM - Re-review: just left a minor README comment but confirming everything is still working well.

…docker-CMS-202

README.md

* Run CMS locally with supporting services in Docker (#38) * Added make commands * Added .env to .dockerignore * Extract dev backing services to their own compose * Added example .env file * Added runbook to the readme * Replaced comonly used commands to convenience aliases in the readme * Updated the makefile * Testing markdown rendering * Formating * Removed redundant settings in example .env * Readme fixes * Fixed typo in the README * Reverted the rename of the env_file in docker-compose.yml * Rename make commands, update the refrences in README and replace django-admin commands with make commands * Added the new section in the readme to the table of contents * Renamed the dev .env file to .development.env * Formatting + error fixes * Remove the 'expose' key from docker compose * Fixed typo Co-authored-by: Dan Braghiș <[email protected]> * Remove the dj aliases and changed the commands in README * Makefile fix * Remove the dj aliases and changed the commands in README (this time for real) * Added the make dev-init script and updated README * Attempt to format the Makefile to make CI pass * Added note about honcho picking up the mounted .env file in the README * Formating * Fixed the rendering of the warning block * Slight rewording * Added in the reword suggestion Co-authored-by: Jake Howard <[email protected]> * Replaced the warning block with an emoji * Updated outdated commands in the README * Move the prerequisites up in the README * Put the superuser auto-create in a separate make command and call it in dev-init command * Add the default superuser name and password in readme * Formating * Final comment fixes --------- Co-authored-by: Dan Braghiș <[email protected]> Co-authored-by: Jake Howard <[email protected]> * Add default heading 1 and breadcrumbs for templates that haven't yet had a banner added (#49) * Add default heading 1 and breadcrumbs for templates that haven't yet had a banner added * Don't show 2 h1s on the release calendar page * Support a mostly read-only database connection for external environment (#44) * Amend the runserver command in the Makefile (#52) * Don't show an full-screen overlay for warnings - only for errors (#51) * Move CODEOWNER file location (#53) * Use cupcake flavour * Fix lint issue + enable gitleaks --------- Co-authored-by: kacperpONS <[email protected]> Co-authored-by: Dan Braghiș <[email protected]> Co-authored-by: Jake Howard <[email protected]> Co-authored-by: Helen Chapman <[email protected]>

kacperpONS added 4 commits November 22, 2024 11:56

Added make commands

215efab

Added .env to .dockerignore

2a144ac

Extract dev backing services to their own compose

12d53f2

Added example .env file

30d2521

kacperpONS requested a review from a team as a code owner November 22, 2024 13:49

kacperpONS added 4 commits November 22, 2024 14:03

Added runbook to the readme

7ea7d44

Replaced comonly used commands to convenience aliases in the readme

095a908

Updated the makefile

e10103f

Testing markdown rendering

58d3b88

MebinAbraham marked this pull request as draft November 22, 2024 14:25

Formating

e122582

sanjeevz3009 self-requested a review November 22, 2024 22:04

kacperpONS changed the title ~~Run CMS locally with supporting services in Docker CMS-202~~ Run CMS locally with supporting services in Docker Nov 25, 2024

kacperpONS and others added 3 commits November 25, 2024 08:33

Removed redundant settings in example .env

c80aa58

Readme fixes

7d7a59b

Merge branch 'main' into run-cms-locally-with-supporting-services-in-…

4db23a4

…docker-CMS-202

kacperpONS marked this pull request as ready for review November 25, 2024 08:43

nehakerung reviewed Nov 25, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

RealOrangeOne reviewed Nov 25, 2024

View reviewed changes

docker-compose.yml Outdated Show resolved Hide resolved

kacperpONS added 2 commits November 25, 2024 10:32

Fixed typo in the README

e79cbe9

Reverted the rename of the env_file in docker-compose.yml

302e7a1

nehakerung reviewed Nov 25, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

sanjeevz3009 requested changes Nov 25, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

MebinAbraham reviewed Nov 25, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

docker-compose-dev.yml Outdated Show resolved Hide resolved

.env-dev-example Outdated Show resolved Hide resolved

Makefile Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

sanjeevz3009 reviewed Nov 26, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

sanjeevz3009 approved these changes Nov 26, 2024

View reviewed changes

sanjeevz3009 reviewed Nov 26, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

kacperpONS added 3 commits November 26, 2024 17:40

Rename make commands, update the refrences in README and replace djan…

043821b

…go-admin commands with make commands

Added the new section in the readme to the table of contents

9bfa70b

Renamed the dev .env file to .development.env

0e6372c

Attempt to format the Makefile to make CI pass

23200ad

zerolab approved these changes Dec 2, 2024

View reviewed changes

RealOrangeOne approved these changes Dec 2, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

kacperpONS added 4 commits December 2, 2024 13:27

Added note about honcho picking up the mounted .env file in the README

64948c7

Formating

19428d9

Fixed the rendering of the warning block

d8284cf

Slight rewording

0723987

RealOrangeOne reviewed Dec 2, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

RealOrangeOne approved these changes Dec 2, 2024

View reviewed changes

zerolab approved these changes Dec 2, 2024

View reviewed changes

Added in the reword suggestion

a9384f7

Co-authored-by: Jake Howard <[email protected]>

MebinAbraham requested changes Dec 2, 2024

View reviewed changes

kacperpONS added 6 commits December 2, 2024 18:34

Replaced the warning block with an emoji

f680f35

Updated outdated commands in the README

7cab533

Added load-DS-templates and chagned order in the dev-init command

d91c281

Move the prerequisites up in the README

579d3d5

Put the superuser auto-create in a separate make command and call it …

787371b

…in dev-init command

Add the default superuser name and password in readme

2b567d6

nehakerung reviewed Dec 3, 2024

View reviewed changes

README.md Show resolved Hide resolved

kacperpONS and others added 2 commits December 3, 2024 10:16

Merge branch 'main' into run-cms-locally-with-supporting-services-in-…

b47e94b

…docker-CMS-202

Formating

d68372c

MebinAbraham approved these changes Dec 3, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Final comment fixes

45dba11

MebinAbraham approved these changes Dec 3, 2024

View reviewed changes

kacperpONS merged commit 7b68940 into main Dec 3, 2024
7 checks passed

kacperpONS deleted the run-cms-locally-with-supporting-services-in-docker-CMS-202 branch December 3, 2024 16:13

MebinAbraham mentioned this pull request Dec 12, 2024

Introduce Functional Tests using Playwright and Behave #31

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Run CMS locally with supporting services in Docker #38

Run CMS locally with supporting services in Docker #38

kacperpONS commented Nov 22, 2024 •

edited

Loading

MebinAbraham left a comment

sanjeevz3009 left a comment •

edited

Loading

kacperpONS commented Dec 2, 2024 •

edited

Loading

nehakerung commented Dec 3, 2024

Run CMS locally with supporting services in Docker #38

Run CMS locally with supporting services in Docker #38

Conversation

kacperpONS commented Nov 22, 2024 • edited Loading

What is the context of this PR?

How to review

Follow-up Actions

MebinAbraham left a comment

Choose a reason for hiding this comment

sanjeevz3009 left a comment • edited Loading

Choose a reason for hiding this comment

kacperpONS commented Dec 2, 2024 • edited Loading

nehakerung commented Dec 3, 2024

kacperpONS commented Nov 22, 2024 •

edited

Loading

sanjeevz3009 left a comment •

edited

Loading

kacperpONS commented Dec 2, 2024 •

edited

Loading