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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 7, 2023
Merged

(DOCSP-33859): Edge Server: Add required networking details #623

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7467403
Add required networking details
dacharyc Nov 2, 2023
969cde4
Incorporate review feedback
dacharyc Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions source/edge-server/configure.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Copy link
Collaborator

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.

Suggested change
To accept connections from sync clients or connections via the wireprotocol,
To accept connections from sync clients or connections using the wireprotocol,

the host that runs the Edge Server must allow access to incoming connections.

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.
Copy link
Collaborator

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:

Suggested change
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.

Copy link
Collaborator Author

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.


If you run Edge Server on your own infrastructure, you don't need to open
the instance to the general internet. You only need to ensure your client
devices can access it.

Edge Server supports TLS. You can find configuration details in the
"Complete the Edge Server Configuration Details" section.
Copy link
Collaborator

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?


.. _edge-server-os-support:

Expand Down
Loading