Docker Compose

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

Prerequisites

Make sure you have the following prerequisites:

macOS or Linux - Instill Core CE works on macOS or Linux.
Windows - Instill Core CE works on Windows through Windows Linux Subsystem (WSL2). To set up Instill Core CE on Windows, follow these steps:
- Install the latest version of yq from the GitHub Repository, as the package yq is not installed on Ubuntu WSL2 by default.
- Install the latest version of Docker Desktop on Windows and enable the WSL2 integration by following the Docker tutorial.
- (optional) Install the cuda-toolkit on WSL2 by following the Nvidia tutorial.
Docker and Docker Compose - Instill Core CE uses Docker Compose to run all services locally. See the Docker official instructions and the Resource Requirements.

Setup

On your workstation, run:

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

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 {user.consoleBaseUrl}.

🚧
The code in the main branch reflects ongoing development progress for the next release and may not work as expected. If you'd like to access the cutting-edge version of Instill Core CE, simply run make latest.

Teardown

To teardown and clean up all Instill Core CE resources, run:

make down