Installation
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:
- Git (see GitHub’s set up Git guide)
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
- Podman
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.
- Mac users
- Linux users
- Windows users
Install using Docker for Mac.
Install Docker server.
To get started on Windows you first need to install WSL 2 (Windows Subsystem for Linux). This lets developers install a Linux distribution directly on Windows.
Check out our documentation here, after that you can continue on this page.
From here on out all commands should be run in a WSL terminal.
Launch Docker. You can verify that it’s running correctly with:
docker run --rm busybox true
The latest versions of Docker have an experimental 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.
- Mac users
- Linux users
- Windows users
Install using Podman for Mac.
Install Podman on Linux.
Depending on the Linux distribution you are using, the Podman version available can be very old (e.g. Ubuntu). Due to issues with Podman versions older than 4.4 (support for different container architectures) we only support Podman versions > 4.4. This is available in the latest Ubuntu LTS (24.04). If you are using an older LTS version, you can take a look at kubic unstable repositories.
Consult the Podman for Windows documentation.
Check whether Podman is correctly set up with:
podman run --rm busybox true
In order to use podman instead of the default Docker container engine, you will need to set the CONVEYOR_CONTAINER_MANAGER environment variable as follows:
export CONVEYOR_CONTAINER_MANAGER=podman
You can add this to your ~/.bash_profile, ~/.bashrc or ~/.zshrc to make it the default for every shell.
Install the CLI
- Mac users
- Linux users
- Windows users
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
The following commands will download and install the CLI:
wget https://app.conveyordata.com/api/info/cli/location/linux/amd64 -O conveyor_linux_amd64.tar.gz
tar -zxvf conveyor_linux_amd64.tar.gz
chmod +x bin/linux/amd64/conveyor
cp bin/linux/amd64/conveyor /usr/local/bin/conveyor
If you want autocompletion you can install these as well:
conveyor completion bash | sudo tee /etc/bash_completion.d/conveyor > /dev/null
conveyor completion zsh | sudo tee "${fpath[1]}/_conveyor" > /dev/null
If you have followed the extended documentation to install WSL 2, you can install as you would on Linux.
The following commands will download and install the CLI:
wget https://app.conveyordata.com/api/info/cli/location/linux/amd64 -O conveyor_linux_amd64.tar.gz
tar -zxvf conveyor_linux_amd64.tar.gz
chmod +x bin/linux/amd64/conveyor
cp bin/linux/amd64/conveyor /usr/local/bin/conveyor
If you want autocompletion you can install these as well:
conveyor completion bash | sudo tee /etc/bash_completion.d/conveyor > /dev/null
conveyor completion zsh | sudo tee "${fpath[1]}/_conveyor" > /dev/null
Log in
Make sure you are logged in to your account on the Conveyor Web Interface. Use your email address to log in.
The Conveyor CLI needs to be authenticated with the Web Interface 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.