feat(book): add documentation for ports #4370
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
Codecov Report
see 10 files with indirect coverage changes
Flags with carried forward coverage won't be shown. Click here to find out more.
|
rkrasiuk
added
C-docs
rkrasiuk
reviewed
Aug 28, 2023
book/jsonrpc/intro.md
Outdated
Comment on lines
133
to
145
| ### Peering Ports | ||
|
|
||
| - **Port:** 30303 | ||
| - **Protocol:** TCP and UDP | ||
| - **Purpose:** Peering with other nodes for synchronization of blockchain data. Nodes communicate through this port to maintain network consensus and share updated information. | ||
| - **Exposure Recommendation:** This port should be exposed to enable seamless interaction and synchronization with other nodes in the network. | ||
|
|
||
| ### Metrics Port | ||
|
|
||
| - **Port:** 9001 | ||
| - **Protocol:** TCP | ||
| - **Purpose:** This port is designated for serving metrics related to the system's performance and operation. It allows internal monitoring and data collection for analysis. | ||
| - **Exposure Recommendation:** By default, this port should not be exposed to the public. It is intended for internal monitoring and analysis purposes. |
There was a problem hiding this comment.
@rkrasiuk I actually had a doubt because there were some ports that didn't belong here. But it makes sense to open a dedicated section in run a node. I just moved this documentation to a new section.
onbjerg
approved these changes
Aug 28, 2023
Closed
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.
Should solve #3550.