Docker: update website with links to docker images

dannywillems · dannywillems · commit 0a4e5c738ae2 · 2025-08-22T10:01:12.000+02:00
diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml
@@ -4,8 +4,8 @@ on:
   push:
 
 env:
-    REGISTRY_NODE_IMAGE: openmina/openmina
-    REGISTRY_FRONTEND_IMAGE: openmina/frontend
+    REGISTRY_NODE_IMAGE: o1labs/mina-rust
+    REGISTRY_FRONTEND_IMAGE: o1labs/mina-rust-frontend
 
 jobs:
   build-mina-node-image:
@@ -109,3 +109,35 @@ jobs:
           path: /tmp/digests/*
           if-no-files-found: error
           retention-days: 1
+
+  # Push images to registry
+  push-images:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/develop' || startsWith(github.ref, 'refs/tags/')
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v5
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Set up environment variables
+        run: |
+          if [[ "${{ github.ref }}" == "refs/heads/develop" ]]; then
+            echo "GIT_COMMIT=${GITHUB_SHA:0:8}" >> $GITHUB_ENV
+          elif [[ "${{ github.ref }}" == refs/tags/* ]]; then
+            echo "GIT_COMMIT=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+          fi
+
+      - name: Build and push mina-rust image
+        run: |
+          make docker-build-mina
+          make docker-push-mina
+
+      - name: Build and push mina-rust-frontend image
+        run: |
+          make docker-build-frontend
+          make docker-push-frontend
diff --git a/website/docs/appendix/docker-installation.mdx b/website/docs/appendix/docker-installation.mdx
@@ -0,0 +1,64 @@
+---
+title: Docker Installation
+description: Docker installation instructions and tested setup scripts
+---
+
+# Docker Installation Guide
+
+## Linux (Ubuntu/Debian)
+
+The following commands are tested on Ubuntu 22.04 and Ubuntu 24.04 in our CI
+pipeline:
+
+import CodeBlock from "@theme/CodeBlock";
+import DockerInstallLinux from "!!raw-loader!../developers/scripts/setup/install-docker.sh";
+
+<CodeBlock language="bash" title="install-docker.sh">
+  {DockerInstallLinux}
+</CodeBlock>
+
+After installation, you'll need to either log out and back in, or use
+`newgrp docker` to apply the group membership.
+
+## macOS
+
+The following commands are tested on macOS in our CI pipeline:
+
+import DockerInstallMacOS from "!!raw-loader!../developers/scripts/setup/install-docker-macos.sh";
+
+<CodeBlock language="bash" title="install-docker-macos.sh">
+  {DockerInstallMacOS}
+</CodeBlock>
+
+**Note**: After installation, you need to manually start Docker Desktop from
+Applications or Launchpad.
+
+## Windows
+
+For Windows, manually download and install
+[Docker Desktop for Windows](https://www.docker.com/products/docker-desktop/).
+
+## Manual Verification
+
+After installation, verify Docker is working:
+
+```bash
+docker --version
+docker run hello-world
+```
+
+## Alternative Manual Installation
+
+If you prefer not to use the automated scripts, you can find manual installation
+instructions in Docker's official documentation:
+
+- [Docker on Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
+- [Docker Desktop for Mac](https://docs.docker.com/desktop/setup/install/mac-install/)
+- [Docker Desktop for Windows](https://docs.docker.com/desktop/setup/install/windows-install/)
+
+## Testing
+
+These installation scripts are tested nightly and on-demand in our CI pipeline
+to ensure they remain functional across different environments. You can see the
+test results in the
+[Documentation Scripts workflow](https://github.com/o1-labs/mina-rust/actions/workflows/test-docs-scripts.yaml).
diff --git a/website/docs/developers/docker-images.md b/website/docs/developers/docker-images.md
@@ -0,0 +1,102 @@
+---
+title: Docker Images
+description:
+  Learn about Mina Rust Docker images, versioning, and how to use them for
+  development and deployment
+---
+
+# Mina Rust Docker Images
+
+The Mina Rust project provides Docker images for easy deployment and testing.
+
+## Available Images
+
+Docker images are available at Docker Hub under the `o1labs` organization:
+
+- **Main Node**: `o1labs/mina-rust` - The core Mina Rust node
+- **Frontend**: `o1labs/mina-rust-frontend` - Web dashboard and monitoring
+  interface
+
+## Image Tags and Versioning
+
+### For Production Use
+
+**Always use version tags for production deployments for stability.** Avoid
+using `latest` tags as they may change unexpectedly.
+
+- **Version tags**: `o1labs/mina-rust:v1.4.2` (recommended for stability)
+- **Commit-based tags**: `o1labs/mina-rust:2b9e87b2` (available for accessing
+  specific features during development, not recommended for general use)
+
+Example:
+
+```bash
+# Use a version tag (recommended for stability)
+docker pull o1labs/mina-rust:v1.4.2
+docker pull o1labs/mina-rust-frontend:v1.4.2
+
+# Commit hashes available for development/testing specific features
+docker pull o1labs/mina-rust:2b9e87b2
+docker pull o1labs/mina-rust-frontend:2b9e87b2
+```
+
+### 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)
+- **On tags**: When version tags are created, images are tagged with the tag
+  name
+
+### Finding Available Tags
+
+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)
+
+## Local Development
+
+For local development and testing, you can build images using the Makefile:
+
+```bash
+# Build images locally
+make docker-build-mina
+make docker-build-frontend
+
+# Push to registry (requires Docker Hub login)
+make docker-push-mina
+make docker-push-frontend
+```
+
+## Architecture Support
+
+Images are built for multiple architectures:
+
+- `linux/amd64` (x86_64)
+- `linux/arm64` (ARM64)
+
+## Using Docker Images
+
+### Running a Basic Node
+
+```bash
+# Pull and run the main node
+docker pull o1labs/mina-rust:v1.4.2
+docker run -p 8302:8302 o1labs/mina-rust:v1.4.2
+```
+
+### Running with Frontend Dashboard
+
+```bash
+# Using Docker Compose (recommended)
+# Download the latest release and use the provided docker-compose files
+
+# Or run containers separately
+docker run -d --name mina-node -p 8302:8302 o1labs/mina-rust:v1.4.2
+docker run -d --name mina-frontend -p 8070:8070 o1labs/mina-rust-frontend:v1.4.2
+```
+
+For complete setup guides, see the
+[Node Operators](../node-operators/getting-started) section.
diff --git a/website/docs/node-operators/alpha-testing.md b/website/docs/node-operators/alpha-testing.md
@@ -14,7 +14,7 @@ Docker. Follow these steps to set up the node and
 
 Ensure you have **Docker** installed:
 
-- [Docker Installation Guide for Linux, macOS, and Windows](./docker-installation.md)
+- [Docker Installation Guide for Linux, macOS, and Windows](../appendix/docker-installation)
 
 ## 2. Download & Start the Node
 
diff --git a/website/docs/node-operators/archive-node.md b/website/docs/node-operators/archive-node.md
@@ -58,7 +58,7 @@ multiple options running simultaneously.
 ## Prerequisites
 
 Ensure Docker and Docker Compose are installed on your system -
-[Docker Installation Guide](./docker-installation.md)
+[Docker Installation Guide](../appendix/docker-installation)
 
 ## Docker compose setup (with archiver process)
 
diff --git a/website/docs/node-operators/block-producer.md b/website/docs/node-operators/block-producer.md
@@ -9,7 +9,7 @@ complete.
 ## Prerequisites
 
 Ensure Docker and Docker Compose are installed on your system -
-[Docker Installation Guide](./docker-installation.md)
+[Docker Installation Guide](../appendix/docker-installation)
 
 ## Download & Start the Node
 
diff --git a/website/docs/node-operators/docker-installation.md b/website/docs/node-operators/docker-installation.md
diff --git a/website/docs/node-operators/getting-started.md b/website/docs/node-operators/getting-started.md
@@ -36,7 +36,32 @@ Choose your preferred installation method:
 
 Docker provides the easiest way to get started with the Mina Rust Node.
 
-[→ Docker Installation Guide](docker-installation)
+[→ Docker Installation Guide](../appendix/docker-installation)
+
+#### Docker Image Usage
+
+Pre-built Docker images are available on Docker Hub:
+
+- **Main Node**: `o1labs/mina-rust`
+- **Frontend Dashboard**: `o1labs/mina-rust-frontend`
+
+**Recommended**: Use version tags for stability:
+
+```bash
+# Use version tags (recommended for stability)
+docker pull o1labs/mina-rust:v1.4.2
+```
+
+**For Development**: Commit hashes are available for accessing specific features
+during development, but are not recommended for general use.
+
+For detailed Docker usage and versioning information, see
+[Docker Images](../developers/docker-images).
+
+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)
 
 ### 2. Build from Source
 
diff --git a/website/docs/node-operators/local-demo.md b/website/docs/node-operators/local-demo.md
@@ -1,7 +1,7 @@
 # Run Block Producers on local network
 
-Once you have completed the [pre-requisites](./docker-installation.md) for your
-operating system, follow these steps:
+Once you have completed the [pre-requisites](../appendix/docker-installation)
+for your operating system, follow these steps:
 
 ## Setup Option 1: Download Docker Compose Files from the Release
 
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -111,6 +111,12 @@ const config: Config = {
           position: 'left',
           label: 'Developers',
         },
+        {
+          type: 'docSidebar',
+          sidebarId: 'appendixSidebar',
+          position: 'left',
+          label: 'Appendix',
+        },
         {
           href: 'https://o1-labs.github.io/mina-rust/api-docs/',
           label: 'API Docs',
@@ -142,6 +148,10 @@ const config: Config = {
               label: 'Developers',
               to: '/docs/developers/architecture',
             },
+            {
+              label: 'Appendix',
+              to: '/docs/appendix/docker-installation',
+            },
             {
               label: 'API Documentation',
               href: 'https://o1-labs.github.io/mina-rust/api-docs/',
diff --git a/website/sidebars.ts b/website/sidebars.ts
