Skip to content
This repository has been archived by the owner on Mar 4, 2024. It is now read-only.

EVEREST-444 Add configurable bind address for the everest container #168

Merged
merged 2 commits into from
Sep 20, 2023

Conversation

recharte
Copy link
Collaborator

@recharte recharte commented Sep 19, 2023

EVEREST-444 Powered by Pull Request Badge

Problem:
In EVEREST-333 (#142) we identified and fixed a security vulnerability where we were exposing everest's port to 0.0.0.0 by default.
However, this fix broke the ability for users to access everest from outside localhost which is must have.

Related pull requests

Cause:
#142

Solution:
Add a EVEREST_BIND_ADDR env var which is 127.0.0.1 by default but allows for users to control the bind address and thus the exposure of the everest container.

CHECKLIST

Jira

  • Is the Jira ticket created and referenced properly?

Tests

  • [ ] Is an Integration test/test case added for the new feature/change?
  • [ ] Are unit tests added where appropriate?

In c591381 we removed the ability for users to access everest from
outside of localhost. Until we implement a configurable way for users to
control the exposure of the everest container we must revert those
changes and re-introduce the ability to run everest with its port
exposed.
@recharte recharte marked this pull request as ready for review September 19, 2023 19:36
@recharte recharte requested a review from a user September 19, 2023 19:36
Copy link
Contributor

@gen1us2k gen1us2k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about having an env variable to set bind addr and by-default it will be 0.0.0.0?

@recharte
Copy link
Collaborator Author

What about having an env variable to set bind addr and by-default it will be 0.0.0.0?

I thought about that as the most likely solution but using 127.0.0.1 as default. But I was planning on doing that in the scope of EVEREST-445.

I separated this into two steps to make sure we can get this workaround right away and then tackle it properly in a follow-up PR because the full solution shall also be well documented in the installation instructions and I didn't know if we would be able to do it right away.

@gen1us2k
Copy link
Contributor

@recharte I added an env var. I'll test it soon

@gen1us2k
Copy link
Contributor

Tested and it works

deploy/quickstart-compose.yml Show resolved Hide resolved
@recharte
Copy link
Collaborator Author

Thanks @gen1us2k, your commit looks good.
Since you went ahead and added the env var, I'll update the EVEREST-444 and EVEREST-445 descriptions accordingly and I'll poke the tech writing team to work on the docs for this then.

@recharte recharte changed the title EVEREST-444 Expose everest to outside localhost EVEREST-444 Add environment variable to control the bind address for the everest container Sep 19, 2023
@recharte recharte changed the title EVEREST-444 Add environment variable to control the bind address for the everest container EVEREST-444 Add configurable bind address for the everest container Sep 19, 2023
@recharte recharte enabled auto-merge (squash) September 19, 2023 20:42
@recharte recharte merged commit c0b2518 into main Sep 20, 2023
@recharte recharte deleted the EVEREST-444-expose-everest-outside-localhost branch September 20, 2023 07:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants