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

docs: add instructions for running celestia-app via Docker #4168

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
+30 −0
Open

docs: add instructions for running celestia-app via Docker #4168

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a0cf884
Fixes #3078: <Run celestia-app via Docker>
abhirajprasad Dec 28, 2024
f5d9a10
Update README.md
abhirajprasad Jan 2, 2025
a654874
Update README.md
abhirajprasad Jan 2, 2025
d9b1477
Update README.md
abhirajprasad Jan 2, 2025
4ac615f
Update README.md
abhirajprasad Jan 2, 2025
cbf13ec
Update README.md
abhirajprasad Jan 2, 2025
d89e99c
Update README.md
abhirajprasad Jan 2, 2025
8e9aaa0
Merge branch 'celestiaorg:main' into feat-fixed-#3078
abhirajprasad Jan 2, 2025
502bf71
Update README.md
abhirajprasad Jan 2, 2025
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
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,36 @@ node | | | |
make install
```

### Docker

1. Prerequisites
- Install [Docker](https://www.docker.com/get-started) 20.10 or higher
Comment on lines +48 to +49
Copy link
Collaborator

Choose a reason for hiding this comment

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

This doesn't format well, see the rendered diff

Screenshot 2025-01-03 at 10 27 37 AM

Suggested change
1. Prerequisites
- Install [Docker](https://www.docker.com/get-started) 20.10 or higher
1. Install [Docker](https://www.docker.com/get-started) 20.10 or higher


2. Fetch the latest tagged release
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a bit misleading because the latest tag on Docker doesn't correspond to the latest tagged release of celestia-app.

The most recent release of celestia-app is v3.2.0.

The latest tag on Docker is currently applied to a different release.
Screenshot 2025-01-03 at 10 31 59 AM

so let's say

Suggested change
2. Fetch the latest tagged release
2. Pull the latest celestia-app Docker image

```bash
docker pull ghcr.io/celestiaorg/celestia-app:latest
```

3. Run the application
To start the application using Docker Compose:
1. Create a `docker-compose.yml` file with the following content:
Comment on lines +56 to +58
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is too verbose and repetitive.

Suggested change
3. Run the application
To start the application using Docker Compose:
1. Create a `docker-compose.yml` file with the following content:
1. 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"]
```
Comment on lines +59 to +70
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we move this into a file in this repo? Perhaps in the docker directory: docker/docker-compose.yml

2. Start the application:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
2. Start the application:
1. Start the application:

```bash
docker-compose up
```

### Prebuilt binary

If you'd rather not install from source, you can download a prebuilt binary from the [releases](https://github.com/celestiaorg/celestia-app/releases) page.
Expand Down
Loading