Skip to content

Prerequisites

This page covers the platform and tooling prerequisites required to run the full end-to-end local single IA node guide.

Platform

  • Linux, or Windows with WSL2 only
  • Run this guide from the WSL filesystem (for example, ~/src).
  • Do not run it from /mnt/c.** Docker containers rely on shared folders (volume mounts), and this does not work reliably from the Windows filesystem.

Required tools

Install/ensure you have the following available:

  • Docker CLI (recommended) or Docker Desktop
  • Java 21 (JDK)
  • Node.js 20
  • Yarn
  • Maven
  • AWS CLI
  • Curl
  • Jq (optional)
  • GitHub Personal Access Token (PAT) with access to GitHub Packages

Operational notes

  • Docker Desktop must be configured to work with your WSL Linux environment (for example Ubuntu under WSL). WSL integration needs to be enabled in the Docker Desktop settings.
  • If docker ps fails with permission errors, ensure your user is in the Docker group, then restart your shell.
  • Environment variables are not shared between terminals.** You must re-export variables (especially passwords and IDs) in each terminal you use.
  • If you change any environment variables used by a running service (especially OPENID_PROVIDER_URL, CLIENT_ID, GROUPS_KEY), stop and restart that service.

Checkpoint

At the end of this page:

  • You are working from the WSL/Linux filesystem (for example, ~/src)
  • Docker is installed and functioning
  • Java, Node, Yarn, Maven, AWS CLI, and Curl are available
  • You have a GitHub PAT with access to GitHub Packages

Next Steps

Maven & Github packages