binding a random api port #3528
Merged
Conversation
This file contains 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
heiytor
force-pushed
the
chore/api-port
branch
2 times, most recently
from
bcdb3a6
to
5e274c0
Compare
otavio
previously approved these changes
Feb 9, 2024
heiytor
force-pushed
the
chore/api-port
branch
from
5e274c0
to
d14a23e
Compare
heiytor
force-pushed
the
ref/internal-client
branch
3 times, most recently
from
9586a4d
to
910da50
Compare
heiytor
force-pushed
the
chore/api-port
branch
2 times, most recently
from
8f75cb6
to
b7f69bb
Compare
Introduces a new `SHELLHUB_API_PORT` variable, which allows the API to randomly select a port when it starts up. While binding the API to port 8080 might seem convenient, it can lead to collision errors when running multiple Docker Compose instances (e.g., testcontainers) because each instance shares the same network. To illustrate, consider two separate Docker Compose instances labeled "A" and "B". In "A", a gateway is running on port 11111, and in "B", a gateway is running on port 22222. Since both APIs are running on port 8080 and both instances share the same network, gateway "A" might mistakenly request data from "B", and vice versa. > !Note: Due to the use of internalclient, this environment should be sent to other services such as "ssh".
heiytor
force-pushed
the
chore/api-port
branch
from
b7f69bb
to
f3091c3
Compare
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.
Introduces a new
SHELLHUB_API_PORTvariable, which allows the API torandomly select a port when it starts up.
While binding the API to port 8080 might seem convenient, it can lead to
collision errors when running multiple Docker Compose instances (e.g.,
testcontainers) because each instance shares the same network.
To illustrate, consider two separate Docker Compose instances labeled
"A" and "B". In "A", a gateway is running on port 11111, and in "B", a
gateway is running on port 22222. Since both APIs are running on port
8080 and both instances share the same network, gateway "A" might
mistakenly request data from "B", and vice versa.