Skip to main content

Prerequisites

OctoMesh is operated using Kubernetes in production. This guide runs the same Helm-chart deployment on a local kind (Kubernetes in Docker) cluster.

The following tools need to be installed on your local machine before you can start the OctoMesh platform:

  • Docker Desktop (or Docker Engine on Linux)
    • Note: the OctoMesh service images are multi-arch (amd64/arm64) as of release 3.4.51, so Windows, Linux, Intel Macs, and Apple Silicon Macs are all supported. Releases older than 3.4.51 are amd64-only.
  • PowerShell 7.4+
  • kind v0.31+ (brew install kind / winget install Kubernetes.kind)
  • kubectl
  • helm v3
  • openssl in PATH (brew install openssl / winget install ShiningLight.OpenSSL.Dev)
  • octo-cli (choco install octo-cli on Windows; download the self-contained binary for macOS/Linux from the Download Center) — minimum version 3.4.51
  • License keys (both prompted during installation):

No hosts-file entry and no manual certificate import are needed: services are reached at *.127-0-0-1.nip.io hostnames (public DNS that resolves to 127.0.0.1) and the installer sets up a locally-trusted certificate authority.

For CLI usage and command reference, see octo-cli.