docs: update docker cmds

[jcstein]

Overview

Resolves #1771

Summary by CodeRabbit

• New Features

  • Updated instructions for running the Celestia Node using Docker, including a new command argument for improved connectivity.
  • Enhanced guidance for setting up a light node with persistent storage, including volume mounting instructions.

• Documentation

  • Clarified setup instructions and added details on creating directories and permissions for Docker on Linux.
  • Maintained structured sections for prerequisites, quick start, and troubleshooting, along with video walkthroughs for user support.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The document how-to-guides/docker-images.md has been updated to improve the instructions for running the Celestia Node using Docker. Key modifications include the addition of the --p2p.network $NETWORK argument in the node startup commands for all network types. The section on setting up a light node with persistent storage has also been clarified, including details on directory creation and permission settings for Docker Engine on Linux. The overall structure remains unchanged, with clear sections for prerequisites, quick start instructions, and troubleshooting tips.

Changes

File	Change Summary
how-to-guides/docker-images.md	Updated commands to include --p2p.network $NETWORK for all network types; clarified light node setup with persistent storage, including directory creation and permission settings.

Possibly related PRs

• docs: use same checkout for node and app #1692: The changes in this PR involve updating the git checkout commands for various environments, including Mainnet Beta, Mocha, and Arabica, which relates to the overall setup process for running nodes, similar to the updates made in the main PR for running the Celestia Node using Docker.
• Update full-storage-node.md #1752: This PR updates the hardware requirements for setting up a Celestia full storage node, which is relevant as it pertains to the setup and operational aspects of running nodes, similar to the focus of the main PR on running a Celestia Node.
• docs: update directory structure in readme #1762: The restructuring of the directory in the README to include /how-to guides aligns with the main PR's focus on improving documentation for running nodes, enhancing user navigation and understanding of the setup process.

Suggested reviewers

• sysrex
• mindstyle85

🐰 In the garden of code, we hop with glee,
New commands sprout, as bright as can be!
With Docker we run, on networks so wide,
Persistent storage, our data's safe guide.
So follow the steps, let’s dance and play,
In the world of Celestia, we’ll find our way! 🌼

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[github-actions]

PR Preview Action v1.4.8
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1769/
on branch main at 2024-10-24 20:06 UTC

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2519da2 and 261d660.

📒 Files selected for processing (1)

• how-to-guides/docker-images.md (1 hunks)

🔇 Additional comments (3)

how-to-guides/docker-images.md (3)

221-221: Same variable inconsistency issue as above.

The command uses undefined $P2P_NETWORK instead of the defined $NETWORK variable.

---

228-228: Same variable inconsistency issue as above.

The command uses undefined $P2P_NETWORK instead of the defined $NETWORK variable.

---

214-228: Verify the impact of p2p network parameter addition.

While adding the --p2p.network parameter is a good improvement, let's verify that this parameter is required and properly documented in the node's configuration guide.

✅ Verification successful

Based on the search results, I can now generate the final response as there is sufficient evidence to verify the usage of the --p2p.network parameter.

The --p2p.network parameter is correctly implemented and well-documented

The parameter is extensively documented across multiple guides and tutorials, showing consistent usage patterns for different networks:

• Mainnet Beta: Optional (defaults to "celestia")
• Mocha testnet: Required with --p2p.network mocha
• Arabica devnet: Required with --p2p.network arabica

The implementation in the docker commands aligns with the established patterns found throughout the documentation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for p2p.network parameter documentation in other files
rg --type md "p2p.network" --glob '!how-to-guides/docker-images.md'

Length of output: 7871