Skip to main content


Set up the local development environment

This is the part of the tutorial with the greatest potential for stumbling-blocks, because it involves the installation of software. However, the prerequisites are very reliable and the vast majority of users encounter no problems at all.

If you do run into any difficulties, don’t hesitate to contact support, who will be glad to help you out.

Before you start

You will need to have the following installed or configured, and know at least the basics of using them, before proceeding:

Install a Container engine

In order to use Conveyor, you need a container engine to build and run OCI containers. At the moment Conveyor supports both Docker and Podman. Docker is still the most popular engine to use, but we notice that some larger customers are switching because of:

  • The change in Docker Desktop licencing costs
  • The fact that Docker runs containers as root

We advise using Docker as the default engine. If you are concerned about the two mentioned issues, you can use Podman instead.


Docker Desktop licencing has changed. After January 31, 2022 companies can choose to either pay a minimal licence fee or use an alternative means to install Docker on their machines.

Install using Docker for Mac

Launch Docker. You can check that it’s running correctly with:

docker run --rm busybox true

The latest versions of Docker have a beta feature to use containerd for pulling and storing images. This feature is known to cause issues with Conveyor, so we strongly recommend to keep this setting disabled.

Install the CLI

The Conveyor CLI is installable using Homebrew. Using homebrew autocompletion for bash, zsh and fish should automatically be installed.

brew install datamindedbe/conveyor-formulas/conveyor

If you already have it installed, check that they are up-to-date:

brew upgrade datamindedbe/conveyor-formulas/conveyor

Log in

Make sure you are logged in to your account on the Conveyor Control Panel. Use your email address to login.

The Conveyor CLI needs to be authenticated with the Control Panel in order to interact with it, using the command:

conveyor auth login

On to the next step

Now you're ready to go on to the next step. Multiple paths are available to you, so you can continue the tutorial using your favorite tool.