You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,11 +37,11 @@ If you are not using a package manager, see the [Node.js download page](https://
37
37
38
38
**Note:** WordPress currently only officially supports Node.js `20.x` and npm `10.x`.
39
39
40
-
You will also need [Docker](https://www.docker.com/products/docker-desktop) installed and running on your computer. Docker is the virtualization software that powers the local development environment. Docker can be installed just like any other regular application.
40
+
You will also need a container environment (e.g. [Docker](https://www.docker.com/products/docker-desktop)or [Podman](https://podman-desktop.io/)) installed and running on your computer. The container environment is the virtualization software that powers the local development environment. Both applications can be installed just like any other regular application.
41
41
42
42
### Development Environment Commands
43
43
44
-
Ensure [Docker](https://www.docker.com/products/docker-desktop)is running before using these commands.
44
+
Ensure either [Docker](https://www.docker.com/products/docker-desktop)or [Podman](https://podman-desktop.io/) are running before using these commands.
45
45
46
46
#### To start the development environment for the first time
47
47
@@ -97,7 +97,7 @@ npm run test:php -- --group <group name or ticket number>
97
97
#### Generating a code coverage report
98
98
PHP code coverage reports are [generated daily](https://github.com/WordPress/wordpress-develop/actions/workflows/test-coverage.yml) and [submitted to Codecov.io](https://app.codecov.io/gh/WordPress/wordpress-develop).
99
99
100
-
After the local Docker environment has [been installed and started](#to-start-the-development-environment-for-the-first-time), the following command can be used to generate a code coverage report.
100
+
After the local container environment has [been installed and started](#to-start-the-development-environment-for-the-first-time), the following command can be used to generate a code coverage report.
101
101
102
102
```
103
103
npm run test:coverage
@@ -109,7 +109,7 @@ The command will generate three coverage reports in HTML, PHP, and text formats,
109
109
110
110
#### To restart the development environment
111
111
112
-
You may want to restart the environment if you've made changes to the configuration in the `docker-compose.yml` or `.env` files. Restart the environment with:
112
+
You may want to restart the environment if you've made changes to the configuration in the `compose.yml` or `.env` files. Restart the environment with:
113
113
114
114
```
115
115
npm run env:restart
@@ -133,20 +133,20 @@ npm run env:start
133
133
134
134
#### Resetting the development environment
135
135
136
-
The development environment can be reset. This will destroy the database and attempt to remove the pulled Docker images.
136
+
The development environment can be reset. This will destroy the database and attempt to remove the pulled container images.
137
137
138
138
```
139
139
npm run env:reset
140
140
```
141
141
142
142
### Apple Silicon machines and old MySQL/MariaDB versions
143
143
144
-
Older MySQL and MariaDB Docker images do not support Apple Silicon processors (M1, M2, etc.). This is true for:
144
+
Older MySQL and MariaDB container images do not support Apple Silicon processors (M1, M2, etc.). This is true for:
145
145
146
146
- MySQL versions 5.7 and earlier
147
147
- MariaDB 5.5
148
148
149
-
When using these versions on an Apple Silicon machine, you must create a `docker-compose.override.yml` file with the following contents:
149
+
When using these versions on an Apple Silicon machine, you must create a `compose.override.yml` file with the following contents:
150
150
151
151
```
152
152
services:
@@ -155,7 +155,7 @@ services:
155
155
platform: linux/amd64
156
156
```
157
157
158
-
Additionally, the "Use Rosetta for x86/AMD64 emulation on Apple Silicon" setting in Docker needs to be disabled for this workaround.
158
+
Additionally, the "Use Rosetta for x86/AMD64 emulation on Apple Silicon" setting in containers needs to be disabled for this workaround.
0 commit comments