Skip to main content

Prerequisites

OctoMesh is operated using Kubernetes in production. These docs describe a possibility to run OctoMesh on a local docker environment.

There are some prerequisites that need to be installed on your local machine before you can start the OctoMesh platform. The installation steps are different for each operating system. Below you will find the prerequisites for Windows, Linux, and Mac.

Windows

Use winget or chocolatey to install the needed software. Run console as administrator and execute the following commands:

Git

Git is needed to clone the getting started repository.

winget install -e --id Git.Git
choco install git

Docker

We run OctoMesh platform in docker containers. Therefore, Docker Desktop is needed.

winget install -e --id Docker.DockerDesktop
choco install docker-desktop

OpenSSL

We need OpenSSL to create certificates for the local OctoMesh platform.

winget install -e --id ShiningLight.OpenSSL
choco install openssl

PowerShell 7+

OctoMesh uses PowerShell scripts to manage the platform. Therefore, PowerShell 7 or higher is needed.

winget install -e --id Microsoft.PowerShell
choco install powershell-core

octo-cli

octo-cli is available via winget and chocolatey:

winget install -e --id meshmakers.octo-cli
# or
choco install octo-cli

As an alternative, you can download the latest release from the Download Center