Skip to content

Commit 22fcca3

Browse files
committed
docs: Update instructions to add released docker compose files option
1 parent bab3eb8 commit 22fcca3

File tree

1 file changed

+40
-13
lines changed

1 file changed

+40
-13
lines changed

README.md

Lines changed: 40 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,54 @@
55

66
[![Openmina Daily](https://github.com/openmina/openmina/actions/workflows/daily.yaml/badge.svg)](https://github.com/openmina/openmina/actions/workflows/daily.yaml) [![Changelog][changelog-badge]][changelog] [![release-badge]][release-link] [![Apache licensed]][Apache link]
77

8-
## Run the block producer
8+
## Run the Block Producer
99

1010
Once you have completed the [pre-requisites](https://github.com/openmina/openmina/blob/main/docs/producer-demo.md#prerequisites) for your operating system, follow these steps:
1111

12+
### Setup Option 1: Download Docker Compose Files from the Release
13+
14+
1. **Download the Docker Compose files:**
15+
- Go to the [Releases page](https://github.com/openmina/openmina/releases) of this repository.
16+
- Download the latest `openmina-vX.Y.Z-docker-compose.zip` (or `.tar.gz`) file corresponding to the release version (available since v0.8.0).
17+
18+
2. **Extract the files:**
19+
- Unzip or untar the downloaded file:
20+
```bash
21+
unzip openmina-vX.Y.Z-docker-compose.zip
22+
```
23+
or
24+
```bash
25+
tar -xzvf openmina-vX.Y.Z-docker-compose.tar.gz
26+
```
27+
- Replace `vX.Y.Z` with the actual release version you downloaded.
28+
29+
3. **Navigate to the extracted directory:**
30+
```bash
31+
cd openmina-vX.Y.Z-docker-compose
32+
```
33+
34+
### Setup Option 2: Clone the Repository
35+
1236
1. **Clone this repository:**
13-
```bash
14-
git clone https://github.com/openmina/openmina.git
15-
```
37+
```bash
38+
git clone https://github.com/openmina/openmina.git
39+
```
1640

1741
2. **Navigate to the repository:**
42+
```bash
43+
cd openmina
44+
```
45+
46+
### Launch
1847

19-
```bash
20-
cd openmina
21-
```
48+
**Run the following command to start the demo:**
49+
```bash
50+
docker compose -f docker-compose.local.producers.yml up --pull always
51+
```
2252

23-
3. **Run the following command to start the demo:**
24-
```sh
25-
docker compose -f docker-compose.local.producers.yml up --pull always
26-
```
53+
And finally:
2754

28-
4. **Open you browser and visit http://localhost:8070**
55+
**Open your browser and visit [http://localhost:8070](http://localhost:8070)**
2956

3057
![image](https://github.com/user-attachments/assets/c8929509-f68b-4281-bcb9-bad03029fa2f)
3158

@@ -74,7 +101,7 @@ Run the Open Mina block producer node by following this [guide](https://github.c
74101

75102
## How to launch the node (with Docker compose):
76103

77-
Run:
104+
From the directory containing the Docker Compose files (either the root of the cloned repository or the directory where the released Docker Compose files were extracted):
78105

79106
```
80107
docker compose up --pull always

0 commit comments

Comments
 (0)