Skip to content

Commit 0243bb0

Browse files
committed
Website: imported missing docs
1 parent 8b92417 commit 0243bb0

File tree

9 files changed

+184
-1
lines changed

9 files changed

+184
-1
lines changed

website/docs/assets/NodeUI.png

963 KB
Loading
1000 KB
Loading
1.23 MB
Loading
Lines changed: 4 additions & 0 deletions
Loading
Lines changed: 4 additions & 0 deletions
Loading
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
sidebar_position: 5
3+
title: Alpha Testing Guide
4+
description: Guide to running the Alpha Rust Node on Devnet
5+
---
6+
7+
# Run Non-Block Producing Node on Devnet
8+
9+
This guide will walk you through running the **Alpha Rust Node** on Devnet using
10+
Docker. Follow these steps to set up the node and
11+
[Provide Feedback](#4-provide-feedback) on this Alpha release.
12+
13+
## 1. Prerequisites
14+
15+
Ensure you have **Docker** installed:
16+
17+
- [Docker Installation Guide for Linux, macOS, and Windows](./docker-installation.md)
18+
19+
## 2. Download & Start the Node
20+
21+
1. **Download the Latest Release**:
22+
- Visit the
23+
[Open Mina Releases](https://github.com/openmina/openmina/releases).
24+
- Download the latest `openmina-vX.Y.Z-docker-compose.zip`.
25+
26+
2. **Extract the Files**:
27+
28+
```bash
29+
unzip openmina-vX.Y.Z-docker-compose.zip
30+
cd openmina-vX.Y.Z-docker-compose
31+
```
32+
33+
Additional optional parameters:
34+
35+
`OPENMINA_LIBP2P_EXTERNAL_IP` Sets your node’s external IP address to help
36+
other nodes find it.
37+
38+
`OPENMINA_LIBP2P_PORT` Sets the port for Libp2p communication.
39+
40+
3. **Start the Node on Devnet and Save Logs**: Start the node and save the logs
41+
for later analysis:
42+
43+
```bash
44+
docker compose up --pull always && docker compose logs > openmina-node.log
45+
```
46+
47+
4. **Access the Dashboard**: Open `http://localhost:8070` in your browser.
48+
49+
The dashboard will show the syncing process in real time.
50+
<img width="1417" alt="image" src="https://github.com/user-attachments/assets/d9a5f5b3-522f-479b-9829-37402c63bb98" />
51+
52+
> **1. Connecting to Peers:** The node connects to peers. You’ll see the
53+
> number of connected, connecting, and disconnected peers grow.
54+
>
55+
> **2. Fetching Ledgers:** The node downloads key data: Staking ledger, Next
56+
> epoch ledger, and Snarked ledger. Progress bars show the download status.
57+
>
58+
> **3. Fetching & Applying Blocks:** The node downloads recent blocks to
59+
> match the network’s current state. The dashboard tracks how many blocks are
60+
> fetched and applied.
61+
62+
## 3. Monitoring and troubleshooting
63+
64+
### Inspecting Saved Logs
65+
66+
If you’ve saved logs to a file, you can use tail or similar tools to view them:
67+
68+
```bash
69+
tail -f openmina-node.log
70+
```
71+
72+
### Restart the Node:
73+
74+
If the node becomes unresponsive or fails to start, restart the setup:
75+
76+
```bash
77+
docker compose down
78+
docker compose up --pull always
79+
```
80+
81+
## 4. Provide Feedback
82+
83+
This Alpha release is for testing purposes. Your feedback is essential. Follow
84+
these steps to report any issues:
85+
86+
1. **Collect Logs**: Use the
87+
[commands above to save logs](#2-download--start-the-node)
88+
2. **Visit Discord**:
89+
[Open Mina Discord Channel](https://discord.com/channels/484437221055922177/1290662938734231552/1290667779317305354)
90+
3. **Describe the Issue**: Briefly explain the problem and steps to reproduce it
91+
4. **Attach Logs**: Discord allows files up to 25MB. If your logs are larger,
92+
use Google Drive or similar
93+
5. **Include a Screenshot**: A dashboard screenshot provides details about node
94+
status, making it easier to diagnose the issue
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
sidebar_position: 1
3+
title: Local WebNode
4+
description: How to build and launch webnode from source
5+
---
6+
7+
# How to build and launch webnode from source
8+
9+
## Steps
10+
11+
Install the rust and node:
12+
13+
```sh
14+
# Install rustup and set the default Rust toolchain to 1.84 (newer versions work too)
15+
curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain 1.84
16+
# Setup the current shell with rustup
17+
source "$HOME/.cargo/env"
18+
19+
# Download and install nvm:
20+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
21+
# in lieu of restarting the shell
22+
\. "$HOME/.nvm/nvm.sh"
23+
# Download and install Node.js:
24+
nvm install 21
25+
```
26+
27+
Clone the repo
28+
29+
```sh
30+
git clone https://github.com/openmina/openmina.git
31+
cd openmina/
32+
```
33+
34+
Build the web node, `wasm-pack` command should take a bit, around 10min
35+
36+
```sh
37+
cargo install wasm-pack
38+
cd node/web
39+
rustup toolchain install nightly
40+
rustup override set nightly
41+
wasm-pack build --target web --out-dir pkg
42+
cp -rf pkg ../../frontend/src/assets/webnode
43+
```
44+
45+
Download `circuit-blobs`, from the root of project run:
46+
47+
```sh
48+
cd frontend/src/assets/webnode
49+
git clone --depth 1 https://github.com/openmina/circuit-blobs.git
50+
```
51+
52+
And create `web-node-secrets.json` in `frontend/src/assets/webnode` it should be
53+
in following format:
54+
55+
```json
56+
{
57+
"publicKey": "B62qk1UDzvtw82kiSznZEtSdFUg9oW8di5p53cVr2FxDBzjv9bW2Wf6",
58+
"privateKey": "EKLf3tJd7aKegmhr5qyghagM25LQ98Cu413f1a5e18ubUMgGZY8x"
59+
}
60+
```
61+
62+
These keys can be generated by running:
63+
64+
```sh
65+
cargo run -r --bin openmina -- misc mina-key-pair
66+
```
67+
68+
Install frontend dependencies and run the webnode:
69+
70+
```sh
71+
cd frontend
72+
npm run start:webnode
73+
```

website/docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ const config: Config = {
5151
},
5252
},
5353
// Enable edit links to GitHub
54-
editUrl: 'https://github.com/o1-labs/openmina/tree/develop/docs/',
54+
editUrl: 'https://github.com/o1-labs/openmina/tree/develop/website/docs/',
5555
},
5656
blog: false, // Disable blog for technical documentation
5757
theme: {

website/sidebars.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ const sidebars: SidebarsConfig = {
3737
label: 'Operations',
3838
items: [
3939
'node-runners/local-demo',
40+
'node-runners/alpha-testing',
41+
],
42+
},
43+
{
44+
type: 'category',
45+
label: 'Web Node',
46+
items: [
47+
'node-runners/webnode/local-webnode',
4048
],
4149
},
4250
{

0 commit comments

Comments
 (0)