Skip to content

docs(devcontainer): update README for PHP 8.4 and FrankenPHP #1476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LukeTowers merged 1 commit into from
Apr 7, 2026
+12 −10
Merged

docs(devcontainer): update README for PHP 8.4 and FrankenPHP #1476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions .devcontainer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
<img src="https://github.com/wintercms/winter/raw/develop/.github/assets/Github%20Banner.png?raw=true" alt="Winter CMS Logo" width="100%" style="max-width: 600px" />
</p>

This development environment container sets up a fully-functional installation of Winter CMS, running on Apache 2 with PHP 8.3, and makes it simple to start working with Winter CMS in VSCode, PHPStorm and online code-editing suites such as GitHub Codespaces.
This development environment container sets up a fully-functional installation of Winter CMS, built on [FrankenPHP](https://frankenphp.dev/) with PHP 8.4. It makes it simple to start working with Winter CMS in VSCode, PHPStorm and online code-editing suites such as GitHub Codespaces.

This image is based on the official [Winter CMS Docker image](https://github.com/wintercms/docker) and inherits all its features. For detailed configuration options, see the [Docker image README](https://github.com/wintercms/docker/blob/main/README.md).

If you opted to use the `bootstrap-winter` feature, which is enabled by default, Winter CMS will be automatically configured and an administrator account will be generated with the credentials **admin / admin** for you to quickly sign in. It is recommended once you have done so that you change this password immediately.

Expand All @@ -17,7 +19,7 @@ The following plugins and themes will be installed automatically with this featu

## Using this environment

When this environment is built, the Apache 2 service is automatically started, with the root folder of the Winter project being used. A preview of the website will be opened immediately - if you do not see this, you can open the **Ports** tab in VSCode to view the URL generated for viewing the project.
When this environment is built, FrankenPHP is automatically started, with the root folder of the Winter project being used. A preview of the website will be opened immediately - if you do not see this, you can open the **Ports** tab in VSCode to view the URL generated for viewing the project.

XDebug is enabled by default, and allows you to quickly use step debugging. It will be available in the **Debug** tab of VSCode or similar screen in other IDEs.

Expand All @@ -27,13 +29,13 @@ By default, when using the `bootstrap-winter` feature, changes to certain folder

The following software is installed in this environment.

- Apache 2.4
- PHP 8.3 with the following extensions:
- FrankenPHP (Caddy)
- PHP 8.4 with the following extensions:
- `intl`
- `gd`
- `xdebug`
- Composer
- NodeJS 22 (including `npm`)
- NodeJS 24 (including `npm`)
- Git

## Using in your own projects
Expand All @@ -43,12 +45,12 @@ You may use this development environment for your own projects, making it a grea
You may disable this feature by modifying the `.devcontainer/devcontainer.json` file before running the container and commenting out the feature:

```json5
"ghcr.io/devcontainers/features/git:1": {},
"./local-features/apache-config": "latest",
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {},
"ghcr.io/devcontainers/features/github-cli:1": {},
// Comment the following feature if you wish to bootstrap and configure Winter manually (ie. you wish to use this for your own project)
//"./local-features/bootstrap-winter": "latest"
"./local-features/bootstrap-winter": "latest"
},
Comment on lines +48 to 53
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Example contradicts “disable bootstrap-winter” instruction

Line 45 says to disable by commenting out the feature, but Line 52 still shows ./local-features/bootstrap-winter enabled in the example. This can mislead users into keeping bootstrap enabled.

Suggested doc fix 
     "features": {
         "ghcr.io/devcontainers/features/common-utils:2": {},
         "ghcr.io/devcontainers/features/github-cli:1": {},
         // Comment the following feature if you wish to bootstrap and configure Winter manually (ie. you wish to use this for your own project)
-        "./local-features/bootstrap-winter": "latest"
+        // "./local-features/bootstrap-winter": "latest"
     },
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {},
"ghcr.io/devcontainers/features/github-cli:1": {},
// Comment the following feature if you wish to bootstrap and configure Winter manually (ie. you wish to use this for your own project)
//"./local-features/bootstrap-winter": "latest"
"./local-features/bootstrap-winter": "latest"
},
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {},
"ghcr.io/devcontainers/features/github-cli:1": {},
// Comment the following feature if you wish to bootstrap and configure Winter manually (ie. you wish to use this for your own project)
// "./local-features/bootstrap-winter": "latest"
},
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.devcontainer/README.md around lines 48 - 53, The example in the "features"
JSON leaves the bootstrap feature enabled even though the text says to disable
it; update the example so the "./local-features/bootstrap-winter": "latest"
entry is commented out or removed from the "features" block (or shown as
disabled) to match the instruction, and ensure the README's example and the note
about disabling bootstrap-winter reference the same state; target the "features"
object and the "./local-features/bootstrap-winter" entry when making this
change.

"overrideFeatureInstallOrder": [
```

If this feature is disabled, you must bootstrap your project manually. This includes:
Expand All @@ -59,7 +61,7 @@ If this feature is disabled, you must bootstrap your project manually. This incl

You may view the `.devcontainer/local-features/bootstrap-winter/bootstrap.sh` file to see how we bootstrap Winter, and run these commands manually. You will only need to do this once per project container.

If you wish to mount your own volumes, use your own databases or any other complex usages, please review the [Docker documentation](https://docs.docker.com/) to set this up on the container.
If you wish to mount your own volumes, use your own databases or any other complex usages, please review the [Winter Docker image documentation](https://github.com/wintercms/docker/blob/main/README.md#persisting-data) or the [FrankenPHP environment variables](https://frankenphp.dev/docs/config/#environment-variables) for configuration options.

## Troubleshooting

Expand Down
Loading