-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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.
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
wp-env https support 8211 #66264
base: trunk
Are you sure you want to change the base?
wp-env https support 8211 #66264
Conversation
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @[email protected]. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.
To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @bgoewert! In case you missed it, we'd love to have you join us in our Slack community. If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information. |
Unsure what I did wrong. My WP account has been connected for some time. |
This will conflict with #65944. If that PR is merged first I can edit this PR to accommodate. I also realized that I did not update the readme or changelog, which I am working on now. |
What?
Provides HTTPS support for wp-env by allows to define the ports used for HTTPS, path of the certificate files, and even creates certificate files if none are specified.
Why?
Addresses #8211
Old PR #53959
I'm sure there are other scenarios that require the use of HTTPS. This allows inexperienced users to easily enable HTTPS if necessary.
How?
If
https
is enabled in the.wp-env.json
config, it uses the default or user defined ports and certificate keypair to enable. You can define a certificate keypair to be used or letdevcert
create certificates if none are defined. A new apache config is created and enabled using this cert. The theWP_HOME
andWP_SITEURL
constants are updated as well.Testing Instructions
"https": true
to.wp-env.json
or.wp-env.override.json
wp-env start
To define ports:
Add
"httpsPort": 1234
and/or"testsHttpsPort": 5678
to the config root.To define certificate files:
Add
"sslCertPath": "/path/to/file.crt"
and"sslKeyPath": "/path/to/file.key"
to the config root. Both must be defined.Note that because of my limited experience, I have not tested with xdebug and the like. However, both the development and tests instances uses the certificate as expected.