Website: reorganize and improve node operators sections

Author: dannywillems

website/docs/developers/docker-images.md

@@ -46,12 +46,40 @@ docker pull o1labs/mina-rust:2b9e87b2
 docker pull o1labs/mina-rust-frontend:2b9e87b2
 ```
 
+### For Development and Testing
+
+For accessing the latest development features, use the `develop` tag:
+
+<!-- prettier-ignore-start -->
+
+:::warning Unstable Development Version
+
+The `develop` tag points to the latest code from the development branch and may
+be unstable. Only use this for development, testing, or accessing the newest
+features. For production use, always use version tags.
+
+:::
+
+<!-- prettier-ignore-stop -->
+
+```bash
+# Latest development version (unstable)
+docker pull o1labs/mina-rust:develop
+docker pull o1labs/mina-rust-frontend:develop
+```
+
+### Latest Tag
+
+The `latest` tag always corresponds to the latest commit on the main branch,
+which represents the current stable release state.
+
 ### Automatic Publishing
 
 Images are automatically built and pushed to Docker Hub:
 
 - **On develop branch**: When commits are pushed to `develop`, images are tagged
-  with the commit hash (8 characters)
+  with the commit hash (8 characters) and also tagged as `develop` for easy
+  access to the latest development version
 - **On release branches**: When commits are pushed to branches starting with
   `release/`, images are tagged with the branch name (e.g., `release/v1.5.0`) -
   useful for testing release candidates
@@ -65,6 +93,22 @@ You can find available tags at:
 - [o1labs/mina-rust on Docker Hub](https://hub.docker.com/r/o1labs/mina-rust/tags)
 - [o1labs/mina-rust-frontend on Docker Hub](https://hub.docker.com/r/o1labs/mina-rust-frontend/tags)
 
+## Quick Start with Docker Compose
+
+The easiest way to get started is using the provided docker-compose
+configuration:
+
+```bash
+# Clone the repository
+git clone https://github.com/o1-labs/mina-rust.git
+cd mina-rust
+
+# Start node and frontend
+docker-compose up -d
+
+# Access the frontend at http://localhost:8070
+```
+
 ## Local Development
 
 For local development and testing, you can build images using the Makefile:

website/docs/node-operators/archive-node.md

@@ -1,77 +1,204 @@
 # Run Archive Node
 
 This guide is intended for setting up archive nodes on **Mina Devnet** only. Do
-not use this guide for Mina Mainnet
+not use this guide for Mina Mainnet until necessary security audits are
+complete.
 
-## Archive Mode Configuration
+---
 
-We start archive mode in Mina Rust by setting one of the following flags along
-with their associated environment variables:
+## Prerequisites
+
+Ensure Docker and Docker Compose are installed on your system -
+[Docker Installation Guide](../appendix/docker-installation)
 
-### Archiver Process (`--archive-archiver-process`)
+## Download & Start the Archive Node
 
-Stores blocks in a database by receiving them directly from the Mina Rust node
+1. **Download the Latest Release**
+   - Visit the
+     [Mina Rust Releases](https://github.com/o1-labs/mina-rust/releases)
+   - Download the latest `mina-rust-vX.Y.Z-docker-compose.zip`
+   - Extract the Files:
 
-**Required Environment Variables**:
+     ```bash
+     unzip mina-rust-vX.Y.Z-docker-compose.zip
+     cd mina-rust-vX.Y.Z-docker-compose
+     ```
 
-- `MINA_ARCHIVE_ADDRESS`: Network address for the archiver service
+2. **Launch Archive Node**
+
+   The archive node setup includes a PostgreSQL database, the archiver process,
+   and the Mina Rust node. The archiver process stores blocks in the database by
+   receiving them from the Mina Rust node.
+
+   ```bash
+   docker compose -f docker-compose.archive.devnet.yml up -d --pull always
+   ```
+
+   **Configuration Options:**
+   - `MINA_RUST_TAG` - Docker image tag for the mina-rust node (default:
+     `latest`)
+   - `POSTGRES_PASSWORD` - Database password for PostgreSQL
+   - `PG_PORT` - PostgreSQL port (default: `5432`)
+   - `PG_DB` - Database name (default: `archive`)
+
+   **Examples with different versions:**
+
+   ```bash
+   # Use specific version (recommended for production)
+   env MINA_RUST_TAG="v1.4.2" \
+   docker compose -f docker-compose.archive.devnet.yml up -d --pull always
+
+   # Use development version (latest features, may be unstable)
+   env MINA_RUST_TAG="develop" \
+   docker compose -f docker-compose.archive.devnet.yml up -d --pull always
+   ```
+
+3. **Monitor the Archive Node**
+
+   The archive node will be accessible at:
+   - **Archive API**: http://localhost:3086
+   - **Node API**: http://localhost:3000
+
+## Node Parameters Reference
+
+For a complete list of all available archive node parameters and configuration
+options, see the
+[Mina Rust API Documentation](https://o1-labs.github.io/mina-rust/api-docs/mina_cli/commands/node/struct.NodeArgs.html).
+This includes detailed descriptions of:
+
+- **Archive configuration flags**: `--archive-archiver-process`,
+  `--archive-local-storage`, `--archive-gcp-storage`, `--archive-aws-storage`
+- **Network settings**: `--libp2p-*`, `--network`, `--port`
+- **Logging and debugging options**: `--verbosity`, `--log-*`
+- **Performance tuning parameters**: Connection limits, timeouts, etc.
+- **Security and validation settings**: Key management, validation options
+
+You can also view available parameters by running:
+
+```bash
+# View all node subcommand options
+mina node --help
+
+# View specific archive-related options
+mina node --help | grep -A 10 -B 2 archive
+```
+
+The source code documentation can be found in
+[`cli/src/commands/node/mod.rs`](https://github.com/o1-labs/mina-rust/blob/develop/cli/src/commands/node/mod.rs)
+which contains comprehensive examples and parameter descriptions for all archive
+node configurations.
 
-### Local Storage (`--archive-local-storage`)
+## Using Make Command
 
-Stores blocks in the local filesystem
+As an alternative to Docker Compose, you can run the archive node directly using
+the Makefile target. This method requires building from source.
 
-**Required Environment Variables**:
+### Prerequisites
 
-- (None)
+- Rust toolchain installed
+- Git repository cloned and accessible
+- PostgreSQL database running and configured
 
-**Optional Environment Variables**:
+### Archive Mode Configuration
+
+Mina Rust supports multiple archive modes that can be run simultaneously for
+redundancy:
+
+**Archiver Process (`--archive-archiver-process`)**
+
+Stores blocks in a database by receiving them directly from the Mina Rust node.
+
+**Required Environment Variables:**
+
+- `MINA_ARCHIVE_ADDRESS`: Network address for the archiver service
+
+**Local Storage (`--archive-local-storage`)**
+
+Stores blocks in the local filesystem.
+
+**Optional Environment Variables:**
 
 - `MINA_ARCHIVE_LOCAL_STORAGE_PATH`: Custom path for block storage (default:
-  ~/.mina/archive-precomputed)
+  `~/.mina/archive-precomputed`)
 
-### GCP Storage (`--archive-gcp-storage`)
+**GCP Storage (`--archive-gcp-storage`)**
 
-Uploads blocks to a Google Cloud Platform bucket
+Uploads blocks to a Google Cloud Platform bucket.
 
-**Required Environment Variables**:
+**Required Environment Variables:**
 
 - `GCP_CREDENTIALS_JSON`: Service account credentials JSON
 - `GCP_BUCKET_NAME`: Target storage bucket name
 
-### AWS Storage (`--archive-aws-storage`)
+**AWS Storage (`--archive-aws-storage`)**
 
-Uploads blocks to an AWS S3 bucket
+Uploads blocks to an AWS S3 bucket.
 
-**Required Environment Variables**:
+**Required Environment Variables:**
 
 - `AWS_ACCESS_KEY_ID`: IAM user access key
 - `AWS_SECRET_ACCESS_KEY`: IAM user secret key
 - `AWS_DEFAULT_REGION`: AWS region name
 - `AWS_SESSION_TOKEN`: Temporary session token for temporary credentials
 - `MINA_AWS_BUCKET_NAME`: Target S3 bucket name
 
-## Redundancy
+### Setup and Run
 
-The archive mode is designed to be redundant. We can combine the flags to have
-multiple options running simultaneously.
+1. **Run Archive Node with Archiver Process**
 
-## Prerequisites
+   For devnet (default):
 
-Ensure Docker and Docker Compose are installed on your system -
-[Docker Installation Guide](../appendix/docker-installation)
+   ```bash
+   MINA_ARCHIVE_ADDRESS="http://localhost:3086" \
+   make run-node NETWORK=devnet -- --archive-archiver-process
+   ```
 
-## Docker compose setup (with archiver process)
+   For mainnet (when supported):
 
-The compose file sets up a PG database, the archiver process and the Mina Rust
-node. The archiver process is responsible for storing the blocks in the database
-by receiving the blocks from the Mina Rust node.
+   ```bash
+   MINA_ARCHIVE_ADDRESS="http://localhost:3086" \
+   make run-node NETWORK=mainnet -- --archive-archiver-process
+   ```
 
-See
-[docker-compose.archive.devnet.yml](https://github.com/o1-labs/mina-rust/blob/develop/docker-compose.archive.devnet.yml)
-for more details.
+2. **Run with Multiple Archive Modes (Redundancy)**
 
-### Starting the setup
+   You can combine multiple archive modes for redundancy:
 
-```bash
-docker compose -f docker-compose.archive.devnet.yml up -d
-```
+   ```bash
+   # Archive to both database and local storage
+   MINA_ARCHIVE_ADDRESS="http://localhost:3086" \
+   MINA_ARCHIVE_LOCAL_STORAGE_PATH="/path/to/archive" \
+   make run-node NETWORK=devnet -- \
+     --archive-archiver-process \
+     --archive-local-storage
+   ```
+
+   ```bash
+   # Archive to database, local storage, and AWS S3
+   MINA_ARCHIVE_ADDRESS="http://localhost:3086" \
+   MINA_ARCHIVE_LOCAL_STORAGE_PATH="/path/to/archive" \
+   AWS_ACCESS_KEY_ID="your-access-key" \
+   AWS_SECRET_ACCESS_KEY="your-secret-key" \
+   AWS_DEFAULT_REGION="us-west-2" \
+   MINA_AWS_BUCKET_NAME="your-bucket-name" \
+   make run-node NETWORK=devnet -- \
+     --archive-archiver-process \
+     --archive-local-storage \
+     --archive-aws-storage
+   ```
+
+3. **Monitor the Node**
+
+   The node will start and listen on port 3000. You can monitor its status by
+   checking the console output or connecting a frontend dashboard.
+
+### Access Logs
+
+Logs are stored in the working directory with filenames like
+`mina.log.2024-10-14`, `mina.log.2024-10-15`, etc.
+
+### Provide Feedback
+
+Collect logs and report issues on the
+[rust-node-testing](https://discord.com/channels/484437221055922177/1290662938734231552)
+Discord channel. Include reproduction steps if possible.

website/docs/node-operators/block-producer.md

@@ -29,7 +29,32 @@ Ensure Docker and Docker Compose are installed on your system -
 
    [Docker Compose](https://github.com/o1-labs/mina-rust/blob/develop/docker-compose.block-producer.yml)
    references `mina-workdir`. It stores a private key and logs for block
-   production. Place your block producer's private key into the `mina-workdir`
+   production.
+
+   **Option A: Generate a new key pair (if you don't have one)**
+
+   If you don't have a block producer key, you can generate one using the
+   Makefile target:
+
+   ```bash
+   # Clone the repository first if you haven't already
+   git clone https://github.com/o1-labs/mina-rust.git
+   cd mina-rust
+
+   # Generate a new encrypted key pair
+   make generate-block-producer-key
+
+   # Or generate with a password
+   make generate-block-producer-key MINA_PRIVKEY_PASS="YourPassword"
+   ```
+
+   This will create:
+   - `mina-workdir/producer-key` (encrypted private key)
+   - `mina-workdir/producer-key.pub` (public key)
+
+   **Option B: Use an existing key**
+
+   If you already have a block producer key, place it into the `mina-workdir`
    directory and name it `producer-key`:
 
    ```bash
@@ -49,20 +74,37 @@ Ensure Docker and Docker Compose are installed on your system -
    docker compose -f docker-compose.block-producer.yml up -d --pull always
    ```
 
-   Optional parameters:
+   **Configuration Options:**
+   - `MINA_RUST_TAG` - Docker image tag for the mina-rust node (default:
+     `latest`)
+   - `MINA_FRONTEND_TAG` - Docker image tag for the frontend (default: `latest`)
+   - `MINA_LIBP2P_EXTERNAL_IP` - Sets your node's external IP address to help
+     other nodes find it
+   - `MINA_LIBP2P_PORT` - Sets the port for Libp2p communication
+   - `COINBASE_RECEIVER` - Wallet address to receive block rewards
+   - `MINA_PRIVKEY_PASS` - Password for encrypted private key
 
-   `MINA_LIBP2P_EXTERNAL_IP` Sets your node's external IP address to help other
-   nodes find it.
+   **Examples with different versions:**
 
-   `MINA_LIBP2P_PORT` Sets the port for Libp2p communication.
+   ```bash
+   # Use specific version (recommended for production)
+   env MINA_RUST_TAG="v1.4.2" MINA_FRONTEND_TAG="v1.4.2" \
+   COINBASE_RECEIVER="YourWalletAddress" MINA_PRIVKEY_PASS="YourPassword" \
+   docker compose -f docker-compose.block-producer.yml up -d --pull always
+
+   # Use development version (latest features, may be unstable)
+   env MINA_RUST_TAG="develop" MINA_FRONTEND_TAG="develop" \
+   COINBASE_RECEIVER="YourWalletAddress" MINA_PRIVKEY_PASS="YourPassword" \
+   docker compose -f docker-compose.block-producer.yml up -d --pull always
+   ```
 
 4. **Go to Dashboard**
 
    Visit [http://localhost:8070](http://localhost:8070) to
    [monitor sync](http://localhost:8070/dashboard) and
    [block production](http://localhost:8070/block-production).
 
-## Alternative: Using Make Command
+## Using Make Command
 
 As an alternative to Docker Compose, you can run the block producer directly
 using the Makefile target. This method requires building from source.