Skip to content

Latest commit

 

History

History
109 lines (64 loc) · 4.79 KB

docker-readme.md

File metadata and controls

109 lines (64 loc) · 4.79 KB

OctoEverywhere Companion Docker Image

OctoEverywhere's Companion Docker image works with: ✅

OctoEverywhere's Companion Docker image does not work with: ⛔

🤔 Confused? Follow our step-by-step guide to find the right version for your 3D printer!

Official Docker Image: https://hub.docker.com/r/octoeverywhere/octoeverywhere

Official Docker Compose: GitHub Repo File

Required Image Setup Information

There are three modes of the OctoEverywhere docker image depending on what 3D printer you're trying to use.

  • COMPANION_MODE=bambu - Bambu Connect for Bambu Lab 3D printer.
  • COMPANION_MODE=elegoo - Elegoo Connect for the Elegoo Centauri & Centauri Carbon.
  • COMPANION_MODE=klipper - For Klipper / Moonraker based 3D printers.

Different companion modes need different printer information.

Bambu Connect

To use Bambu Connect, you need to get the following information.

These three values must be set as environment vars when you first run the container. Once the container is run, you don't need to include them again, unless you want to update the values.

  • ACCESS_CODE=(code)
  • SERIAL_NUMBER=(serial number)
  • PRINTER_IP=(ip address)

Elegoo Connect

To use Elegoo Connect, you need to get the following information.

The IP address must be set as an environment var when you first run the container. Once the container is run, you don't need to include them again, unless you want to update the values.

  • PRINTER_IP=(ip address)

Klipper Companion

To use Elegoo Connect, you need to get the following information.

  • Your printer's IP address.
  • (optional) Moonraker's server port. Defaults to 7125.
  • (optional) Your web frontend's server port. Defaults to 80.

These three values must be set as environment vars when you first run the container. Once the container is run, you don't need to include them again, unless you want to update the values.

  • PRINTER_IP=(ip address)
  • MOONRAKER_PORT=(port)
  • WEBSERVER_PORT=(port)

Required Persistent Storage

You must map the /data folder in your docker container to a directory on your computer so the plugin can write data that will remain between runs. Failure to do this will require relinking the plugin when the container is destroyed or updated.

Linking Your OctoEverywhere Companion

Once the docker container is running, you need to look at the logs to find the linking URL.

Docker Compose: docker compose logs | grep https://octoeverywhere.com/getstarted

Docker: docker logs octoeverywhere | grep https://octoeverywhere.com/getstarted

Running The Docker Image

Using Docker Compose

Using docker compose is the easiest way to run the OctoEverywhere Companion is using docker image.

  • Install Docker and Docker Compose
  • Clone this repo
  • Edit the ./docker-compose.yml file to enter your environment information.
  • Run docker compose up -d
  • Follow the "Linking Your OctoEverywhere Companion" to link the plugin with your account.

Using Docker

Docker compose is a fancy wrapper to run docker containers. You can also run docker containers manually.

Use a command like this example, but update the required vars.

docker run --name octoeverywhere -e COMPANION_MODE=<mode> -e PRINTER_IP=<ip address> (add other required env vars) -v /your/local/path:/data -d octoeverywhere/octoeverywhere

Follow the "Linking Your OctoEverywhere Companion" to link the plugin with your account.

Building The Image Locally

You can build the docker image locally if you prefer, use the following command.

docker build -t octoeverywhere .