OctoPrint#

OctoPrint The snappy web interface for your 3D printer.

Setup#

To find the serial port and connect to your printer run

ls /dev/serial/by-id/*

then, set the value that corresponds to the 3D printer by going into the config file and under octoprint (in the devices array) add the address that you recieved in the previous step. Using the pattern:

devices: ['/dev/device1', '/dev/device2']

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling octoprint#

Command:#

vlab set octoprint.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

octoprint
enable: True

Finalising changes:#

run: vlab update_one service=octoprint

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, octoprint makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=octoprint to complete the changes

ACCESS#

octoprint (HTTPS) link: https://octoprint.vivumlab.xyz/ octoprint (HTTP) link: http://octoprint.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set octoprint.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

octoprint
https_only: True
Finalising changes:#

run: vlab update_one service=octoprint

AUTH#

Default: False
Options: True/False

Command:#

vlab set octoprint.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

octoprint
auth: True
Finalising changes:#

run: vlab update_one service=octoprint

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set octoprint.domain octoprint.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

octoprint
domain: octoprint.com
Finalising changes:#

run: vlab update_one service=octoprint

SUBDOMAIN#

Default: octoprint
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set octoprint.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

octoprint
subdomain: media
Finalising changes:#

run: vlab update_one service=octoprint

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set octoprint.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

octoprint
version: 2.7
Finalising changes:#

run: vlab update_one service=octoprint

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.