Skip to content

Commit df404b5

Browse files
authored
Merge pull request #615 from openmina/docs/producer-demo
docs: Update producer demo docs too
2 parents b9821ed + 9c350dd commit df404b5

File tree

2 files changed

+42
-14
lines changed

2 files changed

+42
-14
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,16 @@ Once you have completed the [pre-requisites](https://github.com/openmina/openmin
4747

4848
**Run the following command to start the demo:**
4949
```bash
50-
docker compose -f docker-compose.local.producers.yml up --pull always
50+
docker compose -f docker-compose.local.producers.yml up --pull always --force-recreate
5151
```
5252

5353
And finally:
5454

5555
**Open your browser and visit [http://localhost:8070](http://localhost:8070)**
5656

57-
![image](https://github.com/user-attachments/assets/c8929509-f68b-4281-bcb9-bad03029fa2f)
57+
You should see the following screen:
58+
59+
![producer-demo](https://github.com/user-attachments/assets/f0ccc36e-0ee8-4284-a8d7-de0f9a3397d6)
5860

5961
## Description
6062

docs/producer-demo.md

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -81,25 +81,51 @@ The nodes in the demo can sometimes become unresponsive, especially immediately
8181

8282
Once pre-requisites for your OS have been completed, follow these steps (they are the same for Debian-based Linux, Windows and MacOS):
8383

84+
### Setup Option 1: Download Docker Compose Files from the Release
85+
86+
1. **Download the Docker Compose files:**
87+
- Go to the [Releases page](https://github.com/openmina/openmina/releases) of this repository.
88+
- Download the latest `openmina-vX.Y.Z-docker-compose.zip` (or `.tar.gz`) file corresponding to the release version (available since v0.8.0).
89+
90+
2. **Extract the files:**
91+
- Unzip or untar the downloaded file:
92+
```bash
93+
unzip openmina-vX.Y.Z-docker-compose.zip
94+
```
95+
or
96+
```bash
97+
tar -xzvf openmina-vX.Y.Z-docker-compose.tar.gz
98+
```
99+
- Replace `vX.Y.Z` with the actual release version you downloaded.
100+
101+
3. **Navigate to the extracted directory:**
102+
```bash
103+
cd openmina-vX.Y.Z-docker-compose
104+
```
105+
106+
### Setup Option 2: Clone the Repository
107+
84108
1. **Clone this repository:**
85-
```bash
86-
git clone https://github.com/openmina/openmina.git
87-
```
109+
```bash
110+
git clone https://github.com/openmina/openmina.git
111+
```
88112

89113
2. **Navigate to the repository:**
114+
```bash
115+
cd openmina
116+
```
90117

91-
```bash
92-
cd openmina
93-
```
118+
### Launch
94119

95-
3. **Run the following command to start the demo:**
96-
```sh
97-
docker compose -f docker-compose.local.producers.yml up --pull always --force-recreate
98-
```
120+
**Run the following command to start the demo:**
121+
```bash
122+
docker compose -f docker-compose.local.producers.yml up --pull always --force-recreate
123+
```
99124

100-
4. **Open you browser and visit http://localhost:8070**
125+
And finally:
126+
127+
**Open your browser and visit [http://localhost:8070](http://localhost:8070)**
101128

102129
You should see the following screen:
103130

104131
![producer-demo](https://github.com/user-attachments/assets/f0ccc36e-0ee8-4284-a8d7-de0f9a3397d6)
105-

0 commit comments

Comments
 (0)