fix: make server-side hostnames available through KeymanHosts
#53
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
For local environment, we need to use host.docker.internal as the hostname, with corresponding ports, in order for the sites in their containers be able to communicate with each other. This adds `$SERVER_keyman_com` variables etc to the `KeymanHosts` class, in preparation for fixing this across each of the sites. This is also groundwork for allowing the various containers in the production and staging environments to communicate with each other directly, rather than going via cloudflare, which should improve performance and reduce traffic on the cluster. This change will be implemented in a follow-up PR.
mcdurdin
added a commit
to keymanapp/keyman.com
that referenced
this pull request
Feb 13, 2025
* Splits the server-side and client-side references to keyman sites so that docker-based PHP can reference host.docker.internal on development machines for cross-references. * Removes all remaining usage of global `$KeymanHost` variable, instead using `KeymanHost::Instance()` for consistency. * Removes some links to legacy sites such as sentry.keyman.com. * TODO: update to `BOOTSTRAP_VERSION=v0.17` in build.sh before merge. Relates-to: keymanapp/shared-sites#53
1 task
mcdurdin
added a commit
to keymanapp/api.keyman.com
that referenced
this pull request
Feb 13, 2025
* Splits the server-side and client-side references to keyman sites so that docker-based PHP can reference host.docker.internal on development machines for cross-references. * Removes some links to legacy sites such as sentry.keyman.com. * TODO: update to `BOOTSTRAP_VERSION=v0.17` in build.sh before merge. Relates-to: keymanapp/shared-sites#53 Relates-to: keymanapp/keyman.com#545
1 task
mcdurdin
added a commit
to keymanapp/keymanweb.com
that referenced
this pull request
Feb 13, 2025
* Splits the server-side and client-side references to keyman sites so that docker-based PHP can reference host.docker.internal on development machines for cross-references. * TODO: update to `BOOTSTRAP_VERSION=v0.17` in build.sh before merge. Relates-to: keymanapp/shared-sites#53 Relates-to: keymanapp/keyman.com#545 Relates-to: keymanapp/api.keyman.com#272
1 task
mcdurdin
added a commit
to keymanapp/help.keyman.com
that referenced
this pull request
Feb 13, 2025
* Splits the server-side and client-side references to keyman sites so that docker-based PHP can reference host.docker.internal on development machines for cross-references. * TODO: update to `BOOTSTRAP_VERSION=v0.17` in build.sh before merge. Relates-to: keymanapp/shared-sites#53 Relates-to: keymanapp/keyman.com#545 Relates-to: keymanapp/api.keyman.com#272 Relates-to: keymanapp/keymanweb.com#129
This was referenced Feb 13, 2025
darcywong00
reviewed
Feb 13, 2025
Comment on lines
+127
to
+131
| $this->SERVER_s_keyman_com = "http://host.docker.internal:8054"; | ||
| $this->SERVER_api_keyman_com = "http://host.docker.internal:8058"; | ||
| $this->SERVER_help_keyman_com = "http://host.docker.internal:8055"; | ||
| $this->SERVER_keyman_com = "http://host.docker.internal:8053"; | ||
| $this->SERVER_keymanweb_com = "http://host.docker.internal:8057"; |
There was a problem hiding this comment.
Does this mean these port values are never overridden by KEYMAN_COM_PROXY_PORT?
And do they need to be manually kept in sync with keyman-local-ports.inc.sh?
There was a problem hiding this comment.
Yes, if ports change, we'd need to fix both places (plus a couple of other places where this has snuck in)
| $this->SERVER_help_keyman_com = $this->help_keyman_com; | ||
| $this->SERVER_keyman_com = $this->keyman_com; | ||
| $this->SERVER_keymanweb_com = $this->keymanweb_com; | ||
| } | ||
| $this->fixupHosts(); | ||
| } | ||
|
|
||
| private function fixupHosts() { |
There was a problem hiding this comment.
If these correspond to ll 34-35, could we rename to fixupSiteHostname()?
Just trying to follow all the uses of "hosts" in this file...
There was a problem hiding this comment.
I'm hoping to eliminate fixupHosts altogether in a future PR
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For local environment, we need to use host.docker.internal as the hostname, with corresponding ports, in order for the sites in their containers be able to communicate with each other. This adds
$SERVER_keyman_comvariables etc to theKeymanHostsclass, in preparation for fixing this across each of the sites.This is also groundwork for allowing the various containers in the production and staging environments to communicate with each other directly, rather than going via cloudflare, which should improve performance and reduce traffic on the cluster. This change will be implemented in a follow-up PR.