Skip to content
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

add: wp-env start --disable-port-mapping option #65944

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

rjchow
Copy link

@rjchow rjchow commented Oct 8, 2024

What?

Adding a --disable-port-mapping option to the wp-env start CLI command that causes the wp-env container to not have any exposed ports.

Why?

There's currently no way to have multiple instances of wp-env stacks running locally all on port 80/443. This becomes a problem if we want to run containers that are accessed by a reverse proxy sidecar, or for example, the built in DNS functionality of Orbstack.

Note that these services generally expose the endpoints at a hostname that does not allow configuration of alternate ports. Combined with the WordPress automatic port redirection, it ends up with an incompatible situation with the reverse proxy listening on port 80/443 but the user agent getting redirected to the customised port.

It's also problematic when we have other services running on port 80/443, but still want to be able to run our wp-env stack on those ports.

How?

Simply removes the ports configuration from all the containers if the flag is passed in.

Testing Instructions

  1. Run wp-env start --disable-port-mapping
  2. Run docker ps and you should see the wp-env stack without any ports forwarded.
  3. Run wp-env start
  4. Run docker ps and you should see the expected ports being forwarded.

Copy link

github-actions bot commented Oct 8, 2024

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.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: First-time Contributor, [Package] Env.

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.

Copy link

github-actions bot commented Oct 8, 2024

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 props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @rjchow.

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.

Unlinked contributors: rjchow.


To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

github-actions bot commented Oct 8, 2024

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @rjchow! 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.

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Oct 8, 2024
@skorasaurus skorasaurus added the [Tool] Env /packages/env label Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Tool] Env /packages/env
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants