|
5 | 5 |
|
6 | 6 | [](https://github.com/openmina/openmina/actions/workflows/daily.yaml) [![Changelog][changelog-badge]][changelog] [![release-badge]][release-link] [![Apache licensed]][Apache link] |
7 | 7 |
|
8 | | -## Run the block producer |
| 8 | +## Run the Block Producer |
9 | 9 |
|
10 | 10 | 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: |
11 | 11 |
|
| 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 | + |
12 | 36 | 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 | + ``` |
16 | 40 |
|
17 | 41 | 2. **Navigate to the repository:** |
| 42 | + ```bash |
| 43 | + cd openmina |
| 44 | + ``` |
| 45 | + |
| 46 | +### Launch |
18 | 47 |
|
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 | + ``` |
22 | 52 |
|
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: |
27 | 54 |
|
28 | | -4. **Open you browser and visit http://localhost:8070** |
| 55 | +**Open your browser and visit [http://localhost:8070](http://localhost:8070)** |
29 | 56 |
|
30 | 57 |  |
31 | 58 |
|
@@ -74,7 +101,7 @@ Run the Open Mina block producer node by following this [guide](https://github.c |
74 | 101 |
|
75 | 102 | ## How to launch the node (with Docker compose): |
76 | 103 |
|
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): |
78 | 105 |
|
79 | 106 | ``` |
80 | 107 | docker compose up --pull always |
|
0 commit comments