Docker Compose

Docker Compose is the a straightforward way to set up Instill Core in local machines or remote instances.

📘

Instructions on this page have been tested on macOS and Ubuntu 22.04.

Prerequisites

Make sure you have the prerequisites set up:

• macOS or Linux - Instill Core works on macOS or Linux

• Windows - Instill Core works on Windows through Windows Linux Subsystem (WSL2). To set up Instill Core on Windows, follow these steps:

  1. Install the lastest version of yq from the GitHub Repository, as the package yq is not installed on Ubuntu WSL2 by default.

  2. Install the latest version of Docker Desktop on Windows and enable the WSL2 integration by following the Docker tutorial.

  3. (optional) Install the cuda-toolkit on WSL2 by following the Nvidia tutorial.

• Docker and Docker Compose - Instill Core uses Docker Compose to run all services at local. See the official instructions and the Docker Resource Requirements.

Setup

🚧

The code in the main branch reflects ongoing development progress for the next release and may not work as expected. If you need a stable alpha version, use the latest release instead.

On your workstation, run:

git clone -b $VERSION https://github.com/instill-ai/instill-core.git && cd instill-core
make all

Be sure to replace $VERSION with the latest release tag. Once all services are up and running, the Console UI is ready to go at http://localhost:3000.

📘

If you change to a different version of Instill Core, you will need to re-build the docker images by running make build-latest instead of make all.

Shutdown

To shutdown and clean up all Instill Core resources, run

make down