2019-08-05 07:09:14 +00:00
|
|
|
##
|
|
|
|
# Default configuration options for the local dev environment.
|
|
|
|
#
|
2019-12-30 13:46:17 +00:00
|
|
|
# All of these options can be overridden by setting them as environment variables before starting
|
2019-08-05 07:09:14 +00:00
|
|
|
# the environment. You will need to restart your environment when changing any of these.
|
2020-10-28 23:15:07 +00:00
|
|
|
#
|
|
|
|
# Below, the following substitutions can be made:
|
|
|
|
# - '{version}': any major.minor PHP version from 5.2 onwards.
|
2019-08-05 07:09:14 +00:00
|
|
|
##
|
|
|
|
|
|
|
|
# The site will be available at http://localhost:LOCAL_PORT
|
|
|
|
LOCAL_PORT=8889
|
|
|
|
|
|
|
|
# Where to run WordPress from. Valid options are 'src' and 'build'.
|
2023-08-24 17:33:04 +00:00
|
|
|
LOCAL_DIR=src
|
2019-08-05 07:09:14 +00:00
|
|
|
|
2020-10-28 23:15:07 +00:00
|
|
|
# The PHP version to use. Valid options are 'latest', and '{version}-fpm'.
|
2019-08-05 07:09:14 +00:00
|
|
|
LOCAL_PHP=latest
|
|
|
|
|
2022-06-21 23:45:19 +00:00
|
|
|
# Whether or not to enable Xdebug.
|
2019-08-05 07:09:14 +00:00
|
|
|
LOCAL_PHP_XDEBUG=false
|
|
|
|
|
2022-06-21 23:45:19 +00:00
|
|
|
##
|
|
|
|
# The Xdebug features to enable.
|
|
|
|
#
|
|
|
|
# By default, the following features are enabled in the local environment:
|
|
|
|
# - Development helpers (`develop`).
|
|
|
|
# - Step debugging (`debug`).
|
|
|
|
#
|
|
|
|
# To generate a code coverage report, `coverage` mode must be active.
|
|
|
|
#
|
|
|
|
# For a full list of accepted values, see https://xdebug.org/docs/all_settings#mode.
|
|
|
|
##
|
|
|
|
LOCAL_PHP_XDEBUG_MODE=develop,debug
|
|
|
|
|
2019-08-07 11:54:22 +00:00
|
|
|
# Whether or not to enable Memcached.
|
|
|
|
LOCAL_PHP_MEMCACHED=false
|
|
|
|
|
2021-02-10 16:52:13 +00:00
|
|
|
##
|
2020-12-18 15:27:33 +00:00
|
|
|
# The database software to use.
|
|
|
|
#
|
|
|
|
# Supported values are `mysql` and `mariadb`.
|
2021-02-10 16:52:13 +00:00
|
|
|
##
|
2022-04-05 09:31:06 +00:00
|
|
|
LOCAL_DB_TYPE=mysql
|
2020-12-18 15:27:33 +00:00
|
|
|
|
2021-02-10 16:52:13 +00:00
|
|
|
##
|
2020-12-18 15:27:33 +00:00
|
|
|
# The database version to use.
|
|
|
|
#
|
2024-02-08 19:10:10 +00:00
|
|
|
# Defaults to 8.0 with the assumption that LOCAL_DB_TYPE is set to `mysql` above.
|
2020-12-18 15:27:33 +00:00
|
|
|
#
|
2024-02-21 14:32:05 +00:00
|
|
|
# When using `mysql`, see https://hub.docker.com/_/mysql for valid versions.
|
|
|
|
# When using `mariadb`, see https://hub.docker.com/_/mariadb for valid versions.
|
2021-02-10 16:52:13 +00:00
|
|
|
##
|
2024-12-17 14:43:43 +00:00
|
|
|
LOCAL_DB_VERSION=8.4
|
2019-08-05 07:09:14 +00:00
|
|
|
|
Bootstrap/Load: Add support for custom ports in multisite site addresses.
This allows a Multisite network to use an address that includes a port name, such as `example.com:1234`, and adds support for this to the local development environment too. You can now run a Multisite installation on the local development environment, for example at `localhost:8889`.
This also fixes some bugs with running a single site installation on a port, and updates the testing infrastructure so that the whole test suite runs both with and without a port number.
Props djzone, scribu, nacin, ipstenu, F J Kaiser, jeremyfelt, johnjamesjacoby, spacedmonkey, PerS, Clorith, Blackbam, enrico.sorcinelli, Jules Colle, obliviousharmony, desrosj, johnbillion
Fixes #21077, #52088
git-svn-id: https://develop.svn.wordpress.org/trunk@58097 602fd350-edb4-49c9-b593-d223f7449a82
2024-05-04 19:23:31 +00:00
|
|
|
# Whether or not to enable multisite.
|
|
|
|
LOCAL_MULTISITE=false
|
|
|
|
|
2019-08-05 07:09:14 +00:00
|
|
|
# The debug settings to add to `wp-config.php`.
|
|
|
|
LOCAL_WP_DEBUG=true
|
|
|
|
LOCAL_WP_DEBUG_LOG=true
|
|
|
|
LOCAL_WP_DEBUG_DISPLAY=true
|
|
|
|
LOCAL_SCRIPT_DEBUG=true
|
2020-10-10 20:13:11 +00:00
|
|
|
LOCAL_WP_ENVIRONMENT_TYPE=local
|
General: Introduce `WP_DEVELOPMENT_MODE` constant to signify context-specific development mode.
In recent releases, WordPress core added several instances of cache usage around specific files. While those caches are safe to use in a production context, in development certain nuances apply for whether or not those caches make sense to use. Initially, `WP_DEBUG` was used as a temporary workaround, but it was clear that a more granular method to signify a specific development mode was required: For example, caches around `theme.json` should be disabled when working on a theme as otherwise it would disrupt the theme developer's workflow, but when working on a plugin or WordPress core, this consideration does not apply.
This changeset introduces a `WP_DEVELOPMENT_MODE` constant which, for now, can be set to either "core", "plugin", "theme", or an empty string, the latter of which means no development mode, which is also the default. A new function `wp_get_development_mode()` is the recommended way to retrieve that configuration value.
With the new function available, this changeset replaces all existing instances of the aforementioned `WP_DEBUG` workaround to use `wp_get_development_mode()` with a more specific check.
Props azaozz, sergeybiryukov, peterwilsoncc, spacedmonkey.
Fixes #57487.
git-svn-id: https://develop.svn.wordpress.org/trunk@56042 602fd350-edb4-49c9-b593-d223f7449a82
2023-06-26 19:55:28 +00:00
|
|
|
LOCAL_WP_DEVELOPMENT_MODE=core
|
Bootstrap/Load: Add support for custom ports in multisite site addresses.
This allows a Multisite network to use an address that includes a port name, such as `example.com:1234`, and adds support for this to the local development environment too. You can now run a Multisite installation on the local development environment, for example at `localhost:8889`.
This also fixes some bugs with running a single site installation on a port, and updates the testing infrastructure so that the whole test suite runs both with and without a port number.
Props djzone, scribu, nacin, ipstenu, F J Kaiser, jeremyfelt, johnjamesjacoby, spacedmonkey, PerS, Clorith, Blackbam, enrico.sorcinelli, Jules Colle, obliviousharmony, desrosj, johnbillion
Fixes #21077, #52088
git-svn-id: https://develop.svn.wordpress.org/trunk@58097 602fd350-edb4-49c9-b593-d223f7449a82
2024-05-04 19:23:31 +00:00
|
|
|
LOCAL_WP_TESTS_DOMAIN=example.org
|
2019-08-12 08:28:33 +00:00
|
|
|
|
|
|
|
# The URL to use when running e2e tests.
|
|
|
|
WP_BASE_URL=http://localhost:${LOCAL_PORT}
|