PrusaLink Plugin Docker & Docker Compose Setup Guide

OctoEverywhere’s PrusaLink plugin provides free, unlimited remote access, advanced AI failure detection, real-time printer notifications, a remote MCP server for AI, and dedicated iPhone and Android apps specifically designed for 3D printers running PrusaLink. This guide will help you set up the PrusaLink 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 PrusaLink plugin on Windows, our new plugin manager app is much easier to use.

The PrusaLink plugin can also be installed without Docker on a Raspberry Pi or any computer running a Debian Linux OS. If you prefer to use the command line interface (CLI) for installation, follow our CLI guide instead.

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 PrusaLink plugin using a single configuration file and a single command!

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

• Linux
• Mac
• Windows

Find Your PrusaLink’s IP Address

To connect to PrusaLink, you will need the IP address of the device (or 3D printer) it’s running on. Here’s how to find the IP address for PrusaLink:

1. Most Prusa 3D printers will display the PrusaLink IP address on the 3D printer’s Home Screen when PrusaLink is connected and running.
2. If you can’t find the IP address on your 3D printer, you can use the IP address or domain you use to access PrusaLink via your web browser when at home.
3. Log in to your home router, find a list of all devices connected to your network, and locate the PrusaLink device and its IP address.

The IP address will be formatted as xxx.xxx.xxx.xxx. For example: 10.0.0.15 or 192.168.1.50. You might also have a domain name or hostname, such as prusalink.local, which will work as well.

Find Your PrusaLink’s Username And Password

For OctoEverywhere’s PrusaLink plugin to connect with PrusaLink, you need to supply either your PrusaLink username and password or your PrusaLink API Key.

Your PrusaLink username and password are what you use when connecting to PrusaLink via your web browser on your home network.

• PrusaLink default user: admin
• PrusaLink default password: prusa

Find Your PrusaLink’s API Key

If you don’t want to use your PrusaLink username and password, you can also use your PrusaLink API key. To get or generate your PrusaLink API key, do the following:

1. Open PrusaLink in your browser.
2. Click the “Settings” text at the top right.
3. Scroll down to “API Key”
4. Copy the API key.

TIP: If the API key is blank, click the “Reset” button to generate it! This will happen the first time you try to access the API key.

Set up the PrusaLink Plugin With Docker Compose

You are now ready to run OctoEverywhere’s PrusaLink 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-prusalink:
    image: octoeverywhere/octoeverywhere:latest
    environment:
        # Required to set the Docker container in PrusaLink mode.
      - COMPANION_MODE=prusalink
        # https://octoeverywhere.com/s/prusalink-ip
      - PRINTER_IP=XXX.XXX.XXX.XXX
        # https://octoeverywhere.com/s/prusa-link-password
      - USERNAME=username
      - PASSWORD=your-password
        # https://octoeverywhere.com/s/prusa-link-api-key
      - API_KEY=your-api-key
    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 the actual IP address of your printer. If needed, use this example PrusaLink docker-compose.yml file for help.

You must also set either your PrusaLink username and password, or the PrusaLink API key you got above.

TIP: You can run multiple PrusaLink plugin Docker containers for multiple Prusa 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 The PrusaLink Plugin In Docker Compose

To start the PrsuaLink plugin using Docker Compose, simply run the following command:

docker compose up -d

Now, the OctoEverywhere PursaLink plugin 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 for OctoEverywhere.com in the Docker logs to link your PrusaLink 3D printer to your OctoEverywhere account.

Done! 🎉

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

In the future, to update the PrusaLink 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!