Skip to content

Commit 0758670

Browse files
docs(devcontainer): update README for PHP 8.4 and FrankenPHP (#1476)
1 parent 5391afa commit 0758670

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

.devcontainer/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
<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" />
55
</p>
66

7-
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.
7+
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.
8+
9+
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).
810

911
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.
1012

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

1820
## Using this environment
1921

20-
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.
22+
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.
2123

2224
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.
2325

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

2830
The following software is installed in this environment.
2931

30-
- Apache 2.4
31-
- PHP 8.3 with the following extensions:
32+
- FrankenPHP (Caddy)
33+
- PHP 8.4 with the following extensions:
3234
- `intl`
3335
- `gd`
3436
- `xdebug`
3537
- Composer
36-
- NodeJS 22 (including `npm`)
38+
- NodeJS 24 (including `npm`)
3739
- Git
3840

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

4547
```json5
46-
"ghcr.io/devcontainers/features/git:1": {},
47-
"./local-features/apache-config": "latest",
48+
"features": {
49+
"ghcr.io/devcontainers/features/common-utils:2": {},
50+
"ghcr.io/devcontainers/features/github-cli:1": {},
4851
// Comment the following feature if you wish to bootstrap and configure Winter manually (ie. you wish to use this for your own project)
49-
//"./local-features/bootstrap-winter": "latest"
52+
"./local-features/bootstrap-winter": "latest"
5053
},
51-
"overrideFeatureInstallOrder": [
5254
```
5355

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

6062
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.
6163

62-
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.
64+
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.
6365

6466
## Troubleshooting
6567

0 commit comments

Comments
 (0)