Merge pull request #818 from openmina/block-producer-guide

Add Block producer guide & Edit Local Block Producer Demo

Author: lukasimrich

.DS_Store

@@ -7,7 +7,7 @@
 
 ## Run the Block Producer
 
-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:
+Once you have completed the [pre-requisites](./docs/docker-installation.md) for your operating system, follow these steps:
 
 ### Setup Option 1: Download Docker Compose Files from the Release
 
@@ -263,4 +263,4 @@ npm start
 [release-link]: https://github.com/openmina/openmina/releases/latest
 
 [Apache licensed]: https://img.shields.io/badge/license-Apache_2.0-blue.svg
-[Apache link]: https://github.com/openmina/openmina/blob/master/LICENSE
+[Apache link]: https://github.com/openmina/openmina/blob/master/LICENSE

README.md

@@ -0,0 +1,53 @@
+# Rust Node Block Production Testing on Devnet
+
+This guide is intended for setting up block producer nodes on **Mina Devnet** only.  
+Do not use this guide for Mina Mainnet until necessary security audits are complete.
+
+
+---
+
+### 0. Prerequisites
+
+Ensure Docker and Docker Compose are installed on your system - [Docker Installation Guide](./docker-installation.md)
+
+### 1. Setup Directories
+Create the main directory and a subdirectory `openmina-workdir`. [Docker Compose](../docker-compose.block-producer.yml) references  `openmina-workdir`. It stores a private key and logs for block production. 
+
+```bash
+mkdir -p ~/mina-node/openmina-workdir cd ~/mina-node
+```
+
+### 2. Prepare Your Keys
+Place your block producer's private key into the `openmina-workdir` directory and name it `producer-key`:
+
+```bash
+cp /path/to/your/private_key producer-key
+```
+Replace `/path/to/your/private_key` with the actual path to your private key file.
+
+### 3. Launch Block Producer
+Download the Docker Compose file:
+
+```bash
+curl -O https://raw.githubusercontent.com/openmina/openmina/main/docker-compose.block-producer.yml
+```
+
+Launch the block producer with `MINA_PRIVKEY_PASS` to set the private key password. Optionally, use `COINBASE_RECEIVER` to set a different coinbase receiver:
+
+```bash
+env COINBASE_RECEIVER="YourWalletAddress" MINA_PRIVKEY_PASS="YourPassword" \
+docker compose -f docker-compose.block-producer.yml up -d --pull always
+```
+
+### 4. Access Dashboard
+
+Visit [http://localhost:8070](http://localhost:8070) to [monitor sync](http://localhost:8070/dashboard) and [block production](http://localhost:8070/block-production).
+
+### 5. Logs
+
+Logs are stored in `openmina-workdir` with filenames like `openmina.log.2024-10-14`, `openmina.log.2024-10-15`, etc.
+
+### 6. Feedback
+
+Collect logs from `openmina-workdir` and report issues on the [rust-node-testing](https://discord.com/channels/484437221055922177/1290662938734231552) discord channel. Include reproduction steps if possible.
+

docs/block-producer-guide.md

@@ -0,0 +1,65 @@
+# Docker Installation Guide
+
+## Installation for
+
+- [Debian-based Linux](#docker-installation-on-debian-based-linux)
+- [Windows](#docker-installation-on-windows)
+- [macOS](#docker-installation-on-macos)
+
+## Docker Installation on Debian-based Linux
+
+1. Set up Docker's apt repository:
+
+    ```bash
+    # Add Docker's official GPG key:
+    sudo apt-get update
+    sudo apt-get install ca-certificates curl
+    sudo install -m 0755 -d /etc/apt/keyrings
+    sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
+    sudo chmod a+r /etc/apt/keyrings/docker.asc
+
+    # Add the repository to Apt sources:
+    echo \
+    "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
+    $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
+    sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+    sudo apt-get update
+    ```
+
+2. Install the Docker packages:
+
+    ```bash
+    sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
+    ```
+
+3. Add your user to the `docker` group:
+
+    ```bash
+    sudo usermod -aG docker $USER
+    newgrp docker
+    ```
+
+4. Verify the installation:
+
+    ```bash
+    docker run hello-world
+    ```
+
+---
+
+## Docker Installation on Windows
+
+1. Download and Install [Docker Desktop for Windows](https://www.docker.com/products/docker-desktop/).
+
+2. Ensure Docker Desktop is running (check the system tray icon).
+
+---
+
+### Docker Installation on macOS
+
+1. Download and Install [Docker Desktop for Mac](https://www.docker.com/products/docker-desktop/).
+2. Verify the installation in Terminal:
+
+    ```bash
+    docker --version
+    ```