Skip to content

docs: update 2121 port for nodes #1871

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

Merged
merged 1 commit into from
Jan 25, 2025
Merged

docs: update 2121 port for nodes #1871

merged 1 commit into from
Jan 25, 2025

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Jan 25, 2025

Overview

Summary by CodeRabbit

  • Documentation
    • Added important warning sections to bridge and full storage node setup guides about ensuring port 2121 TCP/UDP is open and publicly accessible for proper P2P network connectivity.

@jcstein jcstein requested review from Wondertan and renaynay January 25, 2025 00:34
Copy link
Contributor

coderabbitai bot commented Jan 25, 2025

Walkthrough

The pull request adds a new warning section to two documentation files: how-to-guides/bridge-node.md and how-to-guides/full-storage-node.md. The warning emphasizes the critical importance of ensuring port 2121 (TCP/UDP) is open and publicly accessible for both bridge and full storage nodes. This addition aims to improve user awareness about network connectivity requirements, highlighting that proper port configuration is essential for effective node participation in the network.

Changes

File Change Summary
how-to-guides/bridge-node.md Added a new warning section about port 2121 TCP/UDP accessibility
how-to-guides/full-storage-node.md Added a new warning section about port 2121 TCP/UDP accessibility

Possibly related PRs

Suggested reviewers

  • mindstyle85

Poem

🐰 Port 2121, oh so bright,
Open wide, connect with might!
TCP and UDP, dancing free,
Network nodes in harmony,
Rabbit's wisdom: keep ports clear! 🌐


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

PR Preview Action v1.6.0

🚀 View preview at
https://celestiaorg.github.io/docs-preview/pr-1871/

Built to branch main at 2025-01-25 00:35 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
how-to-guides/full-storage-node.md (1)

75-77: LGTM! Consider adding port forwarding guidance.

The warning is well-placed and effectively communicates the critical nature of port 2121 accessibility. The message is clear and consistent with the bridge node documentation.

Consider adding a brief note about port forwarding being required if running behind NAT/firewall, as this is a common setup for users running nodes from home networks.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 49e5d7c and 0f879ec.

📒 Files selected for processing (2)
  • how-to-guides/bridge-node.md (1 hunks)
  • how-to-guides/full-storage-node.md (1 hunks)
🔇 Additional comments (1)
how-to-guides/bridge-node.md (1)

86-88: LGTM! Warning maintains consistency across node types.

The warning effectively mirrors the one in the full storage node documentation, maintaining a consistent message about port 2121 requirements across different node types.

@renaynay renaynay merged commit 3de1712 into main Jan 25, 2025
6 checks passed
@renaynay renaynay deleted the jcs/2121port branch January 25, 2025 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants