Klipper Companion Docker & Docker Compose Setup Guide

OctoEverywhere’s Klipper Companion provides free and unlimited remote access, advanced AI failure detection, real-time printer notifications, and dedicated iPhone and Android apps for any Klipper-based 3D printer. This guide will help you set up the Klipper Companion plugin using Docker or Docker Compose on Windows, Mac, or Linux. Let’s get started!

New – OctoEverywhere Plugin Manager For Windows: If you’re installing the Klipper Companion plugin on Windows, our new plugin manager app is much easier to use.

The Klipper Companion is only needed for low-power 3D printers or printers without SSH access. If you don’t know what type of OctoEverywhere plugin you need, follow our step-by-step getting started guide!

Install Docker Or Docker Compose

First, let’s explore what Docker is. Docker enables programs to run in containers, which are fully isolated environments, allowing them to run on any computer. It is a popular choice among hobbyists and enterprise users because it offers quick, easy, and robust software management on a device. Adding new programs and services is easy; removing them is just as simple!

Docker Compose is a tool for managing Docker containers. With it, you can set up and run the Klipper Companion plugin with a single configuration file and one command!

To install Docker and Docker Compose, follow one of these guides:

• Linux
• Mac
• Windows

Set up Klipper Companion With Docker Compose

You are now ready to run OctoEverywhere’s Klipper Companion plugin using Docker Compose! Just follow these steps:

1. Create a new folder on your computer to store the Docker Compose file.
2. Inside the folder, create a new file named `docker-compose.yml`.
3. Open your new docker-compose.yml file and add the following:

version: '2'
services:
  octoeverywhere-klipper-companion:
    image: octoeverywhere/octoeverywhere:latest
    environment:
        # Required to set the Docker container in Klipper Companion mode.
      - COMPANION_MODE=klipper
      - PRINTER_IP=XXX.XXX.XXX.XXX

    volumes:
      # This can also be an absolute path as well.
      - ./data:/data

In the docker-compose.yml file, update the PRINTER_IP environment variable with your printer’s actual IP address. If needed, use this example Klipper Companion docker-compose.yml file for help.

You can run multiple Klipper Companion Docker containers for multiple Klipper 3D printers on a single device! To do this, duplicate the `services` section in the Docker Compose file for each additional printer, including the unique details. See this example docker-compose.yml for more information.

Start Klipper Companion In Docker Compose

To start Klipper Companion using Docker Compose, simply run the following command:

docker compose up -d

Now, Klipper Companion is up and running! To check if everything is functioning correctly, you can view the logs by using this command:

docker compose logs

If the plugin started successfully, you will see the startup logs and a block containing a URL to link your printer to your OctoEverywhere account.

Use the URL to OctoEverywhere.com in the Docker logs to link your Klipper 3D printer to your OctoEverywhere account.

Done! 🎉

And that’s it! Your Klipper 3D printer is now connected to OctoEverywhere via the Klipper Companion plugin using Docker Compose. (That’s quite a mouthful!)

In the future, to update the Klipper Companion plugin, simply run the following commands:

docker compose pull
docker compose up

Welcome to the OctoEverywhere community. 🥰 Be sure to join our Discord server and introduce yourself!