Skip to content

Commit 387cf64

Browse files
committed
Test commit
1 parent 07fa6a1 commit 387cf64

File tree

4 files changed

+146
-131
lines changed

4 files changed

+146
-131
lines changed

.DS_Store

6 KB
Binary file not shown.

docs/beta-testing-guide.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Rust Node Block Producer Quick Start Guide
2+
3+
---
4+
5+
## Prerequisites
6+
7+
Ensure Docker and Docker Compose are installed on your system.
8+
9+
- **Docker Installation Guide**: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)
10+
11+
## 1. Setup Work Directory
12+
Create the main directory and a subdirectory to store your node's keys and logs:
13+
14+
```bash
15+
mkdir -p ~/mina-node/openmina-workdir cd ~/mina-node
16+
17+
```
18+
19+
---
20+
21+
## 2. Prepare Your Keys
22+
Place your block producer's private key into the `openmina-workdir` directory and name it `producer-key`:
23+
24+
```bash
25+
cp /path/to/your/private_key producer-key
26+
```
27+
Replace `/path/to/your/private_key` with the actual path to your private key file.
28+
29+
---
30+
31+
32+
## 3. Launch Block Producer
33+
Download the Docker Compose file:
34+
35+
```bash
36+
curl -O https://raw.githubusercontent.com/openmina/openmina/main/docker-compose.block-producer.yml
37+
```
38+
39+
Launch the block producer with parameters `MINA_PRIVKEY_PASS` to specify the password for the private key, and optional `COINBASE_RECEIVER` to make the coinbase receiver an account other than the producer key:
40+
41+
```bash
42+
env COINBASE_RECEIVER="YourWalletAddress" MINA_PRIVKEY_PASS="YourPassword" \
43+
docker compose -f docker-compose.block-producer.yml up -d --pull always
44+
```
45+
---
46+
47+
## 4. Access Dashboard
48+
49+
Visit [http://localhost:8070](http://localhost:8070) to [monitor sync](localhost:8070/dashboard) and [block production](http://localhost:8070/block-production).
50+
51+
---
52+
53+
## 5. Logs & Node Management
54+
55+
Logs are stored in `openmina-workdir`.
56+
57+
To view the logs:
58+
59+
```bash
60+
docker compose -f docker-compose.block-producer.yml logs -f
61+
```
62+
63+
Restart the node:
64+
65+
```bash
66+
docker compose down && docker compose up -d --pull always
67+
```
68+
69+
Update the node to the latest version:
70+
71+
```bash
72+
docker compose pull && docker compose up -d
73+
```
74+
75+
---
76+
77+
78+
## 6. Feedback & Troubleshooting
79+
80+
Collect logs from `openmina-workdir` and report issues on the Open Mina Discord channel. Include reproduction steps if possible.
81+
82+
---

docs/docker-installation.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Docker Installation Guide
2+
3+
## Installation for
4+
- [Debian-based Linux](#docker-installation-on-debian-based-linux)
5+
- [Windows](#docker-installation-on-windows)
6+
- [macOS](#docker-installation-on-macos)
7+
8+
### Docker Installation on Debian-based Linux
9+
10+
1. **Set up Docker's apt repository:**
11+
12+
```bash
13+
# Add Docker's official GPG key:
14+
sudo apt-get update
15+
sudo apt-get install ca-certificates curl
16+
sudo install -m 0755 -d /etc/apt/keyrings
17+
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
18+
sudo chmod a+r /etc/apt/keyrings/docker.asc
19+
20+
# Add the repository to Apt sources:
21+
echo \
22+
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
23+
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
24+
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
25+
sudo apt-get update
26+
```
27+
28+
2. **Install the Docker packages:**
29+
30+
```bash
31+
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
32+
```
33+
34+
3. **Add your user to the `docker` group:**
35+
36+
```bash
37+
sudo usermod -aG docker $USER
38+
newgrp docker
39+
```
40+
41+
4. **Verify the installation:**
42+
43+
```bash
44+
docker run hello-world
45+
```
46+
47+
---
48+
49+
### Docker Installation on Windows
50+
51+
1. **Download and Install [Docker Desktop for Windows](https://www.docker.com/products/docker-desktop/).**
52+
53+
2. **Ensure Docker Desktop is running (check the system tray icon).**
54+
55+
---
56+
57+
### Docker Installation on macOS
58+
59+
1. **Download and Install [Docker Desktop for Mac](https://www.docker.com/products/docker-desktop/).**
60+
2. **Verify the installation in Terminal:**
61+
62+
```bash
63+
docker --version
64+
```

docs/producer-demo.md

Lines changed: 0 additions & 131 deletions
This file was deleted.

0 commit comments

Comments
 (0)