Deploy Helix with Docker via the Helix CLI

We have had a lot of feedback asking for an easier and simpler way of deploying Helix via docker. We have finally made a super simple and easy docker integration to run Helix locally!

TL;DR

• Run helix dockerdev run to deploy Helix locally to Docker.

Pre-requisites

• Ensure you have the most up-to-date version of the Helix CLI (>v1.0.134) installed

  • see installation steps for installation steps

  • if already installed: run helix update

• Ensure you have docker installed, and the docker daemon running

  • Docker desktop installation

  • Docker engine installation

• Write your HelixQL queries.

  • See HelixQL documentation for more information about HelixQL.

  • See Social Network project walk through for a project walk through.

Steps

1. Run cd path/to/queries_dir

2. Run helix dockerdev run

Note that running the helix dockerdev run command in a different queries directory overwrite the queries being run in the container but the data will be persisted within the container between deployments. Run helix dockerdev delete before running helix dockerdev run again to wipe the data in the container.

Other commands

• helix dockerdev run --background to run the docker container in the background.

• helix dockerdev logs to view Docker container logs.

• helix dockerdev stop to stop the Docker development instance.

• helix dockerdev delete to remove the Docker development instance and data.