wordpress/.env.example
Timothy Jacobs 3cd3a00c76 Build Tools: Allow easier customization of the .env file.
The .env file allows for configuring how the WordPress Local environment should be configured. However, because the file is version controlled, developers must be careful not to commit their modifications.

This commit renames the .env file to be .env.example. During env start, the .env.example file is copied to .env if it does not exist. This allows for contributors to continue using the project without thinking about .env and to make changes when needed. This brings WordPress Core into the dotenv project guidelines.

Props johnbillion, afragen, h71, desrosj.
Fixes #52668.


git-svn-id: https://develop.svn.wordpress.org/trunk@59038 602fd350-edb4-49c9-b593-d223f7449a82
2024-09-17 22:25:03 +00:00

70 lines
1.9 KiB
Plaintext

##
# Default configuration options for the local dev environment.
#
# All of these options can be overridden by setting them as environment variables before starting
# the environment. You will need to restart your environment when changing any of these.
#
# Below, the following substitutions can be made:
# - '{version}': any major.minor PHP version from 5.2 onwards.
##
# The site will be available at http://localhost:LOCAL_PORT
LOCAL_PORT=8889
# Where to run WordPress from. Valid options are 'src' and 'build'.
LOCAL_DIR=src
# The PHP version to use. Valid options are 'latest', and '{version}-fpm'.
LOCAL_PHP=latest
# Whether or not to enable Xdebug.
LOCAL_PHP_XDEBUG=false
##
# 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
# Whether or not to enable Memcached.
LOCAL_PHP_MEMCACHED=false
##
# The database software to use.
#
# Supported values are `mysql` and `mariadb`.
##
LOCAL_DB_TYPE=mysql
##
# The database version to use.
#
# Defaults to 8.0 with the assumption that LOCAL_DB_TYPE is set to `mysql` above.
#
# When using `mysql`, see https://hub.docker.com/_/mysql for valid versions.
# When using `mariadb`, see https://hub.docker.com/_/mariadb for valid versions.
##
LOCAL_DB_VERSION=8.0
# Whether or not to enable multisite.
LOCAL_MULTISITE=false
# 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
LOCAL_WP_ENVIRONMENT_TYPE=local
LOCAL_WP_DEVELOPMENT_MODE=core
LOCAL_WP_TESTS_DOMAIN=example.org
# The URL to use when running e2e tests.
WP_BASE_URL=http://localhost:${LOCAL_PORT}