docs : Added instructions for running celestia-app via Docker #3078 #4168
Conversation
abhirajprasad
requested review from
rootulp and
ninabarbakadze
and removed request for
a team
📝 WalkthroughWalkthroughThe pull request introduces a new Docker installation section in the README.md file. This addition provides comprehensive instructions for users interested in deploying the Changes
Sequence DiagramsequenceDiagram
participant User
participant Docker
participant CelestiaApp
User->>Docker: docker pull ghcr.io/celestiaorg/celestia-app:latest
Docker->>CelestiaApp: Fetch latest image
User->>Docker: docker-compose up
Docker->>CelestiaApp: Launch application
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
README.md (3)
45-45: Add blank lines around the section headerFor better readability and consistency with markdown best practices, add blank lines before and after the "Docker Installation" heading.
+ ## Docker Installation +🧰 Tools
🪛 Markdownlint (0.37.0)
45-45: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
47-49: Enhance Docker prerequisites sectionWhile the basic requirements are good, consider adding these important details:
- Instructions for verifying Docker version (
docker --version)- How to check and modify Docker resource settings on different platforms
- Note about Docker daemon being running
1. Prerequisites - Ensure you have Docker version **20.10** or higher installed. You can download it from [Docker's official website](https://www.docker.com/get-started). - Allocate at least **2 CPU cores** and **4 GB of RAM** to Docker for optimal performance. This can be configured in Docker Desktop settings. + +To verify your Docker installation: +```bash +docker --version # Should show version 20.10 or higher +``` + +Resource allocation: +- **Windows/Mac**: Configure in Docker Desktop → Settings → Resources +- **Linux**: Resources are shared with the host system + +Ensure the Docker daemon is running: +```bash +docker info +```🧰 Tools
🪛 Markdownlint (0.37.0)
47-47: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
48-48: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
51-55: Enhance Docker image pulling sectionThe basic pull command is correct, but consider adding these important details:
- Version tag options (latest vs specific versions)
- Image verification steps
- Brief explanation of using GitHub Container Registry
2. Fetching the Latest Tagged Release -To pull the latest tagged release of the `celestia-app` Docker image, run the following command: +The celestia-app Docker images are hosted on GitHub Container Registry (ghcr.io). You can either pull the latest version or a specific release: + +Pull the latest version: ```bash docker pull ghcr.io/celestiaorg/celestia-app:latest ``` + +Or pull a specific version (recommended for production): + ```bash + docker pull ghcr.io/celestiaorg/celestia-app:v1.0.0 # Replace with desired version + ``` + +Verify the image: + ```bash + docker image inspect ghcr.io/celestiaorg/celestia-app:latest + ```🧰 Tools
🪛 Markdownlint (0.37.0)
51-51: Expected: 1; Actual: 2; Style: 1/2/3
Ordered list item prefix(MD029, ol-prefix)
53-53: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README.md
60-60: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
45-45: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
51-51: Expected: 1; Actual: 2; Style: 1/2/3
Ordered list item prefix
(MD029, ol-prefix)
57-57: Expected: 2; Actual: 3; Style: 1/2/3
Ordered list item prefix
(MD029, ol-prefix)
53-53: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
62-62: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
47-47: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
48-48: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
62-62: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
| 3. Running the Application | ||
| To start the application using Docker Compose, navigate to the directory containing your `docker-compose.yml` file and run: | ||
|
|
||
| ```bash | ||
| docker-compose up | ||
| ``` |
There was a problem hiding this comment.
Add essential Docker Compose configuration details
The current instructions assume the existence of a docker-compose.yml file but don't provide one. This is a critical omission that could block users from proceeding.
Please add:
- A sample
docker-compose.ymlfile - Expected behavior after startup
- Basic troubleshooting steps
3. Running the Application
-To start the application using Docker Compose, navigate to the directory containing your `docker-compose.yml` file and run:
+Create a `docker-compose.yml` file with the following content:
+
+ ```yaml
+ version: '3'
+ services:
+ celestia-app:
+ image: ghcr.io/celestiaorg/celestia-app:latest
+ volumes:
+ - ./data:/root/.celestia-app
+ ports:
+ - "26657:26657" # RPC
+ - "26656:26656" # P2P
+ command: ["celestia-appd", "start"]
+ ```
+
+Start the application:
```bash
docker-compose up
```
+
+Expected output:
+- The service will start and begin syncing with the network
+- Logs will show block processing progress
+
+Troubleshooting:
+- Check logs: `docker-compose logs -f`
+- Check container status: `docker-compose ps`
+- Reset data: `docker-compose down -v`🧰 Tools
🪛 Markdownlint (0.37.0)
60-60: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
57-57: Expected: 2; Actual: 3; Style: 1/2/3
Ordered list item prefix
(MD029, ol-prefix)
62-62: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
62-62: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
abhirajprasad
changed the title
abhirajprasad
changed the title
Added Docker Installation Instructions to README.md
This PR introduces a new section in the README.md file for the celestia-app project, providing detailed instructions on how to install and run the application using Docker.
Changes Made:
Added a comprehensive Docker installation section, including: