-
Notifications
You must be signed in to change notification settings - Fork 24
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
(DOCSP-33859): Edge Server: Add required networking details #623
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work, Dachary! No blocking comments, but I do have some questions and suggestions.
@@ -113,8 +113,19 @@ server, or hardware that you provision on-site. | |||
Required Network Access | |||
~~~~~~~~~~~~~~~~~~~~~~~ | |||
|
|||
The host that runs the Edge Server must allow access to port 80 via HTTP | |||
to the general internet. | |||
To accept connections from sync clients or connections via the wireprotocol, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally good to avoid Latin words and phrases.
To accept connections from sync clients or connections via the wireprotocol, | |
To accept connections from sync clients or connections using the wireprotocol, |
source/edge-server/configure.txt
Outdated
While Edge Server is in Preview, you can stand up a demo using EC2 or another | ||
cloud provider by opening port 80 via HTTP to the general internet. | ||
In production, we recommend opening port 443 with SSL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's an implicit suggestion that Preview === dev environment. Do we know if this is true? Beyond that, is using HTTP in a dev environment going away after Edge Server moves out of Preview? If not, we may want to refer to "using Edge Server in a development environment" instead of "While Edge Server is in Preview". Also, maybe we should address the "general internet vs owned infrastructure" a bit earlier?
Here's something to show what I'm getting at:
While Edge Server is in Preview, you can stand up a demo using EC2 or another | |
cloud provider by opening port 80 via HTTP to the general internet. | |
In production, we recommend opening port 443 with SSL. | |
If you need to open Edge Server to the genera internet, you should open different ports with different methods appropriate for your environment. | |
- Development. Use port 80 and HTTP. | |
- Production. Use port 443 and SSL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call - reworded and reorganized this section a little.
source/edge-server/configure.txt
Outdated
devices can access it. | ||
|
||
Edge Server supports TLS. You can find configuration details in the | ||
"Complete the Edge Server Configuration Details" section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are using the "see on this page" construction? Or was that only if we're including links to other sections on the same page?
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/atlas-app-services/master/ 🪵 Logs |
Pull Request Info
Jira
Staged Changes
Reminder Checklist
You might need to also update some corresponding pages. Check if completed or N/A.
Review Guidelines
REVIEWING.md