octoprint.schema
octoprint.schema.config
- class octoprint.schema.config.Config(*, accessControl: ~octoprint.schema.config.access_control.AccessControlConfig = AccessControlConfig(salt=None, userManager='octoprint.access.users.FilebasedUserManager', groupManager='octoprint.access.groups.FilebasedGroupManager', permissionManager='octoprint.access.permissions.PermissionManager', userfile=None, groupfile=None, autologinLocal=False, localNetworks=['127.0.0.0/8', '::1/128'], autologinAs=None, trustBasicAuthentication=False, checkBasicAuthenticationPassword=True, trustRemoteUser=False, remoteUserHeader='REMOTE_USER', addRemoteUsers=False, defaultReauthenticationTimeout=5), api: ~octoprint.schema.config.api.ApiConfig = ApiConfig(key=None, apps={}, allowCrossOrigin=False), appearance: ~octoprint.schema.config.appearance.AppearanceConfig = AppearanceConfig(name='', color=<ColorEnum.default: 'default'>, colorTransparent=False, colorIcon=True, defaultLanguage='_default', showFahrenheitAlso=False, fuzzyTimes=True, closeModalsWithClick=True, showInternalFilename=True, components=ComponentConfig(order=ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager', 'plugin_achievements', 'plugin_achievements_2', 'systeminfo'], generic=[]), disabled=ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[]))), controls: ~typing.List[~typing.Union[~octoprint.schema.config.controls.ControlConfig, ~octoprint.schema.config.controls.ContainerConfig]] = [], devel: ~octoprint.schema.config.devel.DevelConfig = DevelConfig(stylesheet=<StylesheetEnum.css: 'css'>, cache=DevelCacheConfig(enabled=True, preemptive=True), webassets=DevelWebassetsConfig(bundle=True, clean_on_startup=True, minify=True, minify_plugins=False), useFrozenDictForPrinterState=True, showLoadingAnimation=True, sockJsConnectTimeout=30, pluginTimings=False, enableRateLimiter=True, enableCsrfProtection=True), estimation: ~octoprint.schema.config.estimation.EstimationConfig = EstimationConfig(printTime=PrintTimeEstimationConfig(statsWeighingUntil=0.5, validityRange=0.15, forceDumbFromPercent=0.3, forceDumbAfterMin=30.0, stableThreshold=60)), events: ~octoprint.schema.config.events.EventsConfig = EventsConfig(enabled=True, subscriptions=[]), feature: ~octoprint.schema.config.feature.FeatureConfig = FeatureConfig(temperatureGraph=True, sdSupport=True, keyboardControl=True, pollWatched=False, modelSizeDetection=True, rememberFileFolder=False, printStartConfirmation=False, printCancelConfirmation=True, uploadOverwriteConfirmation=True, autoUppercaseBlacklist=['M117', 'M118'], g90InfluencesExtruder=False, enforceReallyUniversalFilenames=False, enableDragDropUpload=True), folder: ~octoprint.schema.config.folder.FolderConfig = FolderConfig(uploads=None, timelapse=None, timelapse_tmp=None, logs=None, virtualSd=None, watched=None, plugins=None, slicingProfiles=None, printerProfiles=None, scripts=None, translations=None, generated=None, data=None), gcodeAnalysis: ~octoprint.schema.config.gcode_analysis.GcodeAnalysisConfig = GcodeAnalysisConfig(maxExtruders=10, throttle_normalprio=0.01, throttle_highprio=0.0, throttle_lines=100, runAt=<RunAtEnum.idle: 'idle'>, bedZ=0.0), plugins: ~octoprint.schema.config.plugins.PluginsConfig = PluginsConfig(disabled=[], forced_compatible=[], sorting_order={}), printerParameters: ~octoprint.schema.config.printer_parameters.PrinterParametersConfig = PrinterParametersConfig(pauseTriggers=[]), printerProfiles: ~octoprint.schema.config.printer_profiles.PrinterProfilesConfig = PrinterProfilesConfig(default=None), scripts: ~octoprint.schema.config.scripts.ScriptsConfig = ScriptsConfig(gcode=GcodeScriptsConfig(afterPrinterConnected=None, beforePrinterDisconnected=None, beforePrintStarted=None, afterPrintCancelled="; disable motors\nM84\n\n;disable all heaters\n{% snippet 'disable_hotends' %}\n{% snippet 'disable_bed' %}\n;disable fan\nM106 S0", afterPrintDone=None, beforePrintPaused=None, afterPrintResumed=None, beforeToolChange=None, afterToolChange=None, snippets={'disable_hotends': '{% if printer_profile.extruder.sharedNozzle %}M104 T0 S0\n{% else %}{% for tool in range(printer_profile.extruder.count) %}M104 T{{ tool }} S0\n{% endfor %}{% endif %}', 'disable_bed': '{% if printer_profile.heatedBed %}M140 S0\n{% endif %}'})), serial: ~octoprint.schema.config.serial.SerialConfig = SerialConfig(port=None, baudrate=None, exclusive=True, lowLatency=False, autoconnect=False, autorefresh=True, autorefreshInterval=1, log=False, timeout=SerialTimeoutConfig(detectionFirst=10.0, detectionConsecutive=2.0, connection=10.0, communication=30.0, communicationBusy=3.0, temperature=5.0, temperatureTargetSet=2.0, temperatureAutoreport=2.0, sdStatus=1.0, sdStatusAutoreport=1.0, posAutoreport=5.0, resendOk=0.5, baudrateDetectionPause=1.0, positionLogWait=10.0), maxCommunicationTimeouts=SerialMaxTimeouts(idle=2, printing=5, long=5), maxWritePasses=5, additionalPorts=[], additionalBaudrates=[], blacklistedPorts=[], blacklistedBaudrates=[], longRunningCommands=['G4', 'G28', 'G29', 'G30', 'G32', 'M400', 'M226', 'M600'], blockedCommands=['M0', 'M1'], ignoredCommands=[], pausingCommands=['M0', 'M1', 'M25'], emergencyCommands=['M112', 'M108', 'M410'], checksumRequiringCommands=['M110'], helloCommand='M110 N0', disconnectOnErrors=True, ignoreErrorsFromFirmware=False, terminalLogSize=20, lastLineBufferSize=50, logResends=True, supportResendsWithoutOk='detect', logPositionOnPause=True, logPositionOnCancel=False, abortHeatupOnCancel=True, waitForStartOnConnect=False, waitToLoadSdFileList=True, alwaysSendChecksum=False, neverSendChecksum=False, sendChecksumWithUnknownCommands=False, unknownCommandsNeedAck=False, sdRelativePath=False, sdAlwaysAvailable=False, sdLowerCase=False, sdCancelCommand='M25', maxNotSdPrinting=2, swallowOkAfterResend=True, repetierTargetTemp=False, externalHeatupDetection=True, supportWait=True, ignoreIdenticalResends=False, identicalResendsCountdown=7, supportFAsCommand=False, firmwareDetection=True, blockWhileDwelling=False, useParityWorkaround='detect', maxConsecutiveResends=10, sendM112OnError=True, disableSdPrintingDetection=False, ackMax=1, sanityCheckTools=True, notifySuppressedCommands='warn', capabilities=SerialCapabilities(autoreport_temp=True, autoreport_sdstatus=True, autoreport_pos=True, busy_protocol=True, emergency_parser=True, extended_m20=True, lfn_write=True), resendRatioThreshold=10, resendRatioStart=100, ignoreEmptyPorts=False, encoding='ascii', enableShutdownActionCommand=False, triggerOkForM29=True), server: ~octoprint.schema.config.server.ServerConfig = ServerConfig(host=None, port=5000, firstRun=True, startOnceInSafeMode=False, ignoreIncompleteStartup=False, seenWizards={}, secretKey=None, heartbeat=900, reverseProxy=ReverseProxyConfig(prefixHeader=None, schemeHeader=None, hostHeader=None, serverHeader=None, portHeader=None, prefixFallback=None, schemeFallback=None, hostFallback=None, serverFallback=None, portFallback=None, trustedDownstream=[]), uploads=UploadsConfig(maxSize=1073741824, nameSuffix='name', pathSuffix='path'), maxSize=102400, commands=CommandsConfig(systemShutdownCommand=None, systemRestartCommand=None, serverRestartCommand=None, localPipCommand=None), onlineCheck=OnlineCheckConfig(enabled=None, interval=900, host='1.1.1.1', port=53, name='octoprint.org'), pluginBlacklist=PluginBlacklistConfig(enabled=None, url='https://plugins.octoprint.org/blacklist.json', ttl=900, timeout=3.05), diskspace=DiskspaceConfig(warning=524288000, critical=209715200), preemptiveCache=PreemptiveCacheConfig(exceptions=[], until=7), ipCheck=IpCheckConfig(enabled=True, trustedSubnets=[]), allowFraming=False, cookies=CookiesConfig(secure=False, samesite=<SameSiteEnum.lax: 'Lax'>), allowedLoginRedirectPaths=[]), slicing: ~octoprint.schema.config.slicing.SlicingConfig = SlicingConfig(enabled=True, defaultSlicer=None, defaultProfiles={}), system: ~octoprint.schema.config.system.SystemConfig = SystemConfig(actions=[]), temperature: ~octoprint.schema.config.temperature.TemperatureConfig = TemperatureConfig(profiles=[TemperatureProfile(name='ABS', extruder=210, bed=100), TemperatureProfile(name='PLA', extruder=180, bed=60)], cutoff=30, sendAutomatically=False, sendAutomaticallyAfter=1), terminalFilters: ~typing.List[~octoprint.schema.config.terminalfilters.TerminalFilterEntry] = [TerminalFilterEntry(name='Suppress temperature messages', regex='(Send: (N\\d+\\s+)?M105)|(Recv:\\s+(ok\\s+([PBN]\\d+\\s+)*)?([BCLPR]|T\\d*):-?\\d+)'), TerminalFilterEntry(name='Suppress SD status messages', regex='(Send: (N\\d+\\s+)?M27)|(Recv: SD printing byte)|(Recv: Not SD printing)'), TerminalFilterEntry(name='Suppress position messages', regex='(Send:\\s+(N\\d+\\s+)?M114)|(Recv:\\s+(ok\\s+)?X:[+-]?([0-9]*[.])?[0-9]+\\s+Y:[+-]?([0-9]*[.])?[0-9]+\\s+Z:[+-]?([0-9]*[.])?[0-9]+\\s+E\\d*:[+-]?([0-9]*[.])?[0-9]+).*'), TerminalFilterEntry(name='Suppress wait responses', regex='Recv: wait'), TerminalFilterEntry(name='Suppress processing responses', regex='Recv: (echo:\\s*)?busy:\\s*processing')], webcam: ~octoprint.schema.config.webcam.WebcamConfig = WebcamConfig(webcamEnabled=True, timelapseEnabled=True, ffmpeg=None, ffmpegThreads=1, ffmpegVideoCodec='libx264', bitrate='10000k', watermark=True, ffmpegCommandline='{ffmpeg} -framerate {fps} -i "{input}" -vcodec {videocodec} -threads {threads} -b:v {bitrate} -f {containerformat} -y {filters} "{output}"', ffmpegThumbnailCommandline='{ffmpeg} -sseof -1 -i "{input}" -update 1 -q:v 0.7 "{output}"', timelapse=TimelapseConfig(type=<TimelapseTypeEnum.off: 'off'>, fps=25, postRoll=0, options=TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None)), cleanTmpAfterDays=7, defaultWebcam='classic', snapshotWebcam='classic'))
- accessControl: AccessControlConfig
- appearance: AppearanceConfig
- controls: List[Union[ControlConfig, ContainerConfig]]
- devel: DevelConfig
- estimation: EstimationConfig
- events: EventsConfig
- feature: FeatureConfig
- folder: FolderConfig
- gcodeAnalysis: GcodeAnalysisConfig
- plugins: PluginsConfig
- printerParameters: PrinterParametersConfig
- printerProfiles: PrinterProfilesConfig
- scripts: ScriptsConfig
- serial: SerialConfig
- server: ServerConfig
- slicing: SlicingConfig
- system: SystemConfig
- temperature: TemperatureConfig
- terminalFilters: List[TerminalFilterEntry]
- webcam: WebcamConfig
- class octoprint.schema.config.access_control.AccessControlConfig(*, salt: Optional[str] = None, userManager: str = 'octoprint.access.users.FilebasedUserManager', groupManager: str = 'octoprint.access.groups.FilebasedGroupManager', permissionManager: str = 'octoprint.access.permissions.PermissionManager', userfile: Optional[str] = None, groupfile: Optional[str] = None, autologinLocal: bool = False, localNetworks: List[str] = ['127.0.0.0/8', '::1/128'], autologinAs: Optional[str] = None, trustBasicAuthentication: bool = False, checkBasicAuthenticationPassword: bool = True, trustRemoteUser: bool = False, remoteUserHeader: str = 'REMOTE_USER', addRemoteUsers: bool = False, defaultReauthenticationTimeout: int = 5)
- addRemoteUsers: bool
If a remote user is not found, add them. Use this only if all users from the remote system can use OctoPrint.
- autologinAs: Optional[str]
The name of the user to automatically log on clients originating from localNetworks as. Must be the name of one of your configured users.
- autologinLocal: bool
If set to true, will automatically log on clients originating from any of the networks defined in localNetworks as the user defined in autologinAs.
- checkBasicAuthenticationPassword: bool
Whether to also check the password provided through Basic Authentication, if the Basic Authentication header is to be trusted. Disabling this will only match the user name in the Basic Authentication header and login the user without further checks, thus disable with caution.
- defaultReauthenticationTimeout: int
Default timeout after which to require reauthentication by a user for dangerous changes, in minutes. Defaults to 5 minutes. Set to 0 to disable reauthentication requirements (SECURITY IMPACT!).
- groupManager: str
groups.yaml in the default configuration folder).
- Type
The group manager implementation to use for accessing group information. Currently only a filebased user manager is implemented which stores configured groups in a YAML file (Default
- groupfile: Optional[str]
The YAML group file to use. If left out defaults to groups.yaml in the default configuration folder.
- localNetworks: List[str]
A list of networks or IPs for which an automatic logon as the user defined in autologinAs will take place. If available OctoPrint will evaluate the X-Forwarded-For HTTP header for determining the client’s IP address. Defaults to anything originating from localhost.
- salt: Optional[str]
Secret salt used for password hashing. DO NOT TOUCH! If changed you will no longer be able to log in with your existing accounts. Default unset, generated on first run.
- trustBasicAuthentication: bool
Whether to trust Basic Authentication headers. If you have setup Basic Authentication in front of OctoPrint and the user names you use there match OctoPrint accounts, by setting this to true users will be logged into OctoPrint as the user during Basic Authentication. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through Basic Authentication!
- trustRemoteUser: bool
Whether to trust remote user headers. If you have setup authentication in front of OctoPrint and the user names you use there match OctoPrint accounts, by setting this to true users will be logged into OctoPrint as the user provided in the header. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through an authenticating reverse proxy!
- class octoprint.schema.config.api.ApiConfig(*, key: Optional[str] = None, apps: Dict[str, str] = {}, allowCrossOrigin: bool = False)
- class octoprint.schema.config.appearance.AppearanceConfig(*, name: str = '', color: ColorEnum = ColorEnum.default, colorTransparent: bool = False, colorIcon: bool = True, defaultLanguage: str = '_default', showFahrenheitAlso: bool = False, fuzzyTimes: bool = True, closeModalsWithClick: bool = True, showInternalFilename: bool = True, components: ComponentConfig = ComponentConfig(order=ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager', 'plugin_achievements', 'plugin_achievements_2', 'systeminfo'], generic=[]), disabled=ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[])))
-
- colorTransparent: bool
Makes the color of the navigation bar “transparent”. In case your printer uses acrylic for its frame 😉.
- components: ComponentConfig
Configures the order and availability of the UI components.
- defaultLanguage: str
Default language of OctoPrint. If left unset OctoPrint will try to match up available languages with the user’s browser settings.
- class octoprint.schema.config.appearance.ColorEnum(value)
An enumeration.
- blue = 'blue'
- default = 'default'
- green = 'green'
- orange = 'orange'
- red = 'red'
- violet = 'violet'
- yellow = 'yellow'
- class octoprint.schema.config.appearance.ComponentConfig(*, order: ComponentOrderConfig = ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager', 'plugin_achievements', 'plugin_achievements_2', 'systeminfo'], generic=[]), disabled: ComponentDisabledConfig = ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[]))
- disabled: ComponentDisabledConfig
Disabled components per container. If a component is included here it will not be included in OctoPrint’s UI at all. Note that this might mean that critical functionality will not be available if no replacement is registered.
- order: ComponentOrderConfig
Defines the order of the components within their respective containers.
- class octoprint.schema.config.appearance.ComponentDisabledConfig(*, navbar: List[str] = [], sidebar: List[str] = [], tab: List[str] = [], settings: List[str] = [], usersettings: List[str] = [], wizard: List[str] = [], about: List[str] = [], generic: List[str] = [])
-
Disabled navbar items.
- class octoprint.schema.config.appearance.ComponentOrderConfig(*, navbar: List[str] = ['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'login'], sidebar: List[str] = ['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab: List[str] = ['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings: List[str] = ['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings: List[str] = ['access', 'interface'], wizard: List[str] = ['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about: List[str] = ['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager', 'plugin_achievements', 'plugin_achievements_2', 'systeminfo'], generic: List[str] = [])
-
Order of navbar items.
- class octoprint.schema.config.controls.ContainerConfig(*, children: List[Union[ContainerConfig, ControlConfig]] = [], name: Optional[str] = None, layout: LayoutEnum = LayoutEnum.vertical)
- children: List[Union[ContainerConfig, ControlConfig]]
A list of children controls or containers contained within this container.
- layout: LayoutEnum
The layout to use for laying out the contained children, either from top to bottom (vertical) or from left to right (horizontal).
- class octoprint.schema.config.controls.ControlConfig(*, name: str, command: Optional[str] = None, commands: Optional[List[str]] = None, script: Optional[str] = None, javascript: Optional[str] = None, additionalClasses: Optional[str] = None, enabled: Optional[str] = None, input: Optional[List[ControlInputConfig]] = [], regex: Optional[str] = None, template: Optional[str] = None, confirm: Optional[str] = None)
- additionalClasses: Optional[str]
Additional classes to apply to the button of a command, commands, script or javascript control, other than the default btn. Can be used to visually style the button, e.g. set to btn-danger to turn the button red.
- command: Optional[str]
A single GCODE command to send to the printer. Will be rendered as a button which sends the command to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with commands and script. The rendered button be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met.
- commands: Optional[List[str]]
A list of GCODE commands to send to the printer. Will be rendered as a button which sends the commands to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with command and script. The rendered button will be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met.
- confirm: Optional[str]
A text to display to the user to confirm his button press. Can be used with sensitive custom controls like changing EEPROM values in order to prevent accidental clicks. The text will be displayed in a confirmation dialog.
- enabled: Optional[str]
A JavaScript snippet returning either true or false determining whether the control should be enabled or not. This allows to override the default logic for the enable state of the control (disabled if printer is offline). The JavaScript snippet is eval’d and processed in a context where the control it is part of is provided as local variable data and the ControlViewModel is available as self.
- input: Optional[List[ControlInputConfig]]
A list of definitions of input parameters for a command or commands, to be rendered as additional input fields. command/commands may contain placeholders to be replaced by the values obtained from the user for the defined input fields.
- javascript: Optional[str]
A JavaScript snippet to be executed when the button rendered for command or commands is clicked. This allows to override the direct sending of the command or commands to the printer with more sophisticated behaviour. The JavaScript snippet is eval’d and processed in a context where the control it is part of is provided as local variable data and the ControlViewModel is available as self.
- name: str
The name of the control, will be displayed either on the button if it’s a control sending a command or as a label for controls which only display output.
- regex: Optional[str]
//docs.python.org/3/library/re.html#regular-expression-syntax) to match against lines received from the printer to retrieve information from it (e.g. specific output). Together with template this allows rendition of received data from the printer within the UI.
- Type
A [regular expression <re-syntax>](https
- script: Optional[str]
The name of a full blown [GCODE script]() to send to the printer. Will be rendered as a button which sends the script to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with command and commands. The rendered button will be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met. Values of input parameters will be available in the template context under the parameter variable (e.g. an input parameter speed will be available in the script template as parameter.speed). On top of that all other variables defined in the [GCODE template context]() will be available.
- template: Optional[str]
{temperature}` for a regex T:s*(?P<temperature>d+(.d*)) or positional groups within the regex (e.g. Position: X={0}, Y={1}, Z={2}, E={3} for a regex X:([0-9.]+) Y:([0-9.]+) Z:([0-9.]+) E:([0-9.]+)).
- Type
A template to use for rendering the match of regex. May contain placeholders in [Python Format String Syntax](https
- Type
//docs.python.org/3/library/string.html#formatstrings) for either named groups within the regex (e.g. `Temperature
- class octoprint.schema.config.controls.ControlInputConfig(*, name: str, parameter: str, default: Union[str, int, float, bool], slider: Optional[ControlSliderInputConfig] = None)
-
- parameter: str
Internal parameter name for the input field, used as a placeholder in command/commands.
- slider: Optional[ControlSliderInputConfig]
If this attribute is included, instead of an input field a slider control will be rendered.
- class octoprint.schema.config.controls.ControlSliderInputConfig(*, min: int = 0, max: int = 255, step: int = 1)
- class octoprint.schema.config.controls.LayoutEnum(value)
An enumeration.
- horizontal = 'horizontal'
- vertical = 'vertical'
- class octoprint.schema.config.devel.DevelCacheConfig(*, enabled: bool = True, preemptive: bool = True)
- class octoprint.schema.config.devel.DevelConfig(*, stylesheet: StylesheetEnum = StylesheetEnum.css, cache: DevelCacheConfig = DevelCacheConfig(enabled=True, preemptive=True), webassets: DevelWebassetsConfig = DevelWebassetsConfig(bundle=True, clean_on_startup=True, minify=True, minify_plugins=False), useFrozenDictForPrinterState: bool = True, showLoadingAnimation: bool = True, sockJsConnectTimeout: float = 30, pluginTimings: bool = False, enableRateLimiter: bool = True, enableCsrfProtection: bool = True)
- cache: DevelCacheConfig
Settings for OctoPrint’s internal caching.
- enableCsrfProtection: bool
Enable or disable the CSRF protection. Careful, disabling this reduces security.
- enableRateLimiter: bool
Enable or disable the rate limiter. Careful, disabling this reduces security.
- stylesheet: StylesheetEnum
Settings for stylesheet preference. OctoPrint will prefer to use the stylesheet type specified here. Usually (on a production install) that will be the compiled css (default). Developers may specify less here too.
- webassets: DevelWebassetsConfig
Settings for OctoPrint’s web asset merging and minifying.
- class octoprint.schema.config.devel.DevelWebassetsConfig(*, bundle: bool = True, clean_on_startup: bool = True, minify: bool = True, minify_plugins: bool = False)
- bundle: bool
if this is set to false, no minification will take place regardless of the minify setting.
- Type
If set to true, OctoPrint will merge all JS, all CSS and all Less files into one file per type to reduce request count. Setting it to false will load all assets individually. Note
- clean_on_startup: bool
Whether to delete generated web assets on server startup (forcing a regeneration).
- class octoprint.schema.config.devel.StylesheetEnum(value)
An enumeration.
- css = 'css'
- less = 'less'
- class octoprint.schema.config.estimation.EstimationConfig(*, printTime: PrintTimeEstimationConfig = PrintTimeEstimationConfig(statsWeighingUntil=0.5, validityRange=0.15, forceDumbFromPercent=0.3, forceDumbAfterMin=30.0, stableThreshold=60))
- printTime: PrintTimeEstimationConfig
Parameters for the print time estimation during an ongoing print job.
- class octoprint.schema.config.estimation.PrintTimeEstimationConfig(*, statsWeighingUntil: float = 0.5, validityRange: float = 0.15, forceDumbFromPercent: float = 0.3, forceDumbAfterMin: float = 30.0, stableThreshold: int = 60)
- forceDumbAfterMin: float
If no estimate could be calculated until this many minutes into the print and no statistical data is available, use dumb linear estimate.
- forceDumbFromPercent: float
If no estimate could be calculated until this percentage and no statistical data is available, use dumb linear estimate. Value between 0 and 1.0.
- stableThreshold: int
Average fluctuation between individual calculated estimates to consider in stable range. Seconds of difference.
- statsWeighingUntil: float
Until which percentage to do a weighted mixture of statistical duration (analysis or past prints) with the result from the calculated estimate if that’s already available. Utilized to compensate for the fact that the earlier in a print job, the least accuracy even a stable calculated estimate provides.
- class octoprint.schema.config.events.EventSubscription(*, event: str, name: Optional[str] = None, command: str, type: SubscriptionTypeEnum, enabled: bool = True, debug: bool = False)
- command: str
The command to execute when the event is triggered, either a GCODE or a system command.
- debug: bool
If set to true, OctoPrint will log the command after performing all placeholder replacements.
- type: SubscriptionTypeEnum
The type of the command.
- class octoprint.schema.config.events.EventsConfig(*, enabled: bool = True, subscriptions: List[EventSubscription] = [])
-
- subscriptions: List[EventSubscription]
A list of event subscriptions.
- class octoprint.schema.config.events.SubscriptionTypeEnum(value)
An enumeration.
- gcode = 'gcode'
- system = 'system'
- class octoprint.schema.config.feature.FeatureConfig(*, temperatureGraph: bool = True, sdSupport: bool = True, keyboardControl: bool = True, pollWatched: bool = False, modelSizeDetection: bool = True, rememberFileFolder: bool = False, printStartConfirmation: bool = False, printCancelConfirmation: bool = True, uploadOverwriteConfirmation: bool = True, autoUppercaseBlacklist: List[str] = ['M117', 'M118'], g90InfluencesExtruder: bool = False, enforceReallyUniversalFilenames: bool = False, enableDragDropUpload: bool = True)
- autoUppercaseBlacklist: List[str]
Commands that should never be auto-uppercased when sent to the printer through the Terminal tab.
- enforceReallyUniversalFilenames: bool
Replace all special characters and spaces with text equivalent to make them universally compatible. Most OS filesystems work fine with unicode characters, but just in case you can revert to the older behaviour by setting this to true.
- pollWatched: bool
Whether to actively poll the watched folder (true) or to rely on the OS’s file system notifications instead (false).
- class octoprint.schema.config.folder.FolderConfig(*, uploads: Optional[str] = None, timelapse: Optional[str] = None, timelapse_tmp: Optional[str] = None, logs: Optional[str] = None, virtualSd: Optional[str] = None, watched: Optional[str] = None, plugins: Optional[str] = None, slicingProfiles: Optional[str] = None, printerProfiles: Optional[str] = None, scripts: Optional[str] = None, translations: Optional[str] = None, generated: Optional[str] = None, data: Optional[str] = None)
- data: Optional[str]
Absolute path where to store additional data. Defaults to the data folder in OctoPrint’s base folder.
- generated: Optional[str]
Absolute path where to store generated files. Defaults to the generated folder in OctoPrint’s base folder.
- logs: Optional[str]
Absolute path where to store logs. Defaults to the logs folder in OctoPrint’s base folder.
- plugins: Optional[str]
Absolute path where to locate and install single file plugins. Defaults to the plugins folder in OctoPrint’s base folder.
- printerProfiles: Optional[str]
Absolute path where to store printer profiles. Defaults to the printerProfiles folder in OctoPrint’s base folder.
- scripts: Optional[str]
Absolute path where to store (GCODE) scripts. Defaults to the scripts folder in OctoPrint’s base folder.
- slicingProfiles: Optional[str]
Absolute path where to store slicing profiles. Defaults to the slicingProfiles folder in OctoPrint’s base folder.
- timelapse: Optional[str]
Absolute path where to store finished timelase recordings. Defaults to the timelapse folder in OctoPrint’s base folder.
- timelapse_tmp: Optional[str]
Absolute path where to store temporary timelapse snapshots. Defaults to the timelapse/tmp folder in OctoPrint’s base folder.
- translations: Optional[str]
Absolute path where to store additional translations. Defaults to the translations folder in OctoPrint’s base folder.
- uploads: Optional[str]
Absolute path where to store gcode uploads. Defaults to the uploads folder in OctoPrint’s base folder.
- class octoprint.schema.config.gcode_analysis.GcodeAnalysisConfig(*, maxExtruders: int = 10, throttle_normalprio: float = 0.01, throttle_highprio: float = 0.0, throttle_lines: int = 100, runAt: RunAtEnum = RunAtEnum.idle, bedZ: float = 0.0)
-
- runAt: RunAtEnum
Whether to run the analysis only when idle (not printing), regardless of printing state or never.
- class octoprint.schema.config.gcode_analysis.RunAtEnum(value)
An enumeration.
- always = 'always'
- idle = 'idle'
- never = 'never'
- class octoprint.schema.config.plugins.PluginsConfig(*, _disabled: List[str] = [], _forcedCompatible: List[str] = [], _sortingOrder: Dict[str, Dict[str, int]] = {})
- class octoprint.schema.config.printer_parameters.PrinterParametersConfig(*, pauseTriggers: List[str] = [])
- class octoprint.schema.config.printer_profiles.PrinterProfilesConfig(*, default: Optional[str] = None)
- class octoprint.schema.config.scripts.GcodeScriptsConfig(*, afterPrinterConnected: Optional[str] = None, beforePrinterDisconnected: Optional[str] = None, beforePrintStarted: Optional[str] = None, afterPrintCancelled: Optional[str] = "; disable motors\nM84\n\n;disable all heaters\n{% snippet 'disable_hotends' %}\n{% snippet 'disable_bed' %}\n;disable fan\nM106 S0", afterPrintDone: Optional[str] = None, beforePrintPaused: Optional[str] = None, afterPrintResumed: Optional[str] = None, beforeToolChange: Optional[str] = None, afterToolChange: Optional[str] = None, snippets: Dict[str, str] = {'disable_bed': '{% if printer_profile.heatedBed %}M140 S0\n{% endif %}', 'disable_hotends': '{% if printer_profile.extruder.sharedNozzle %}M104 T0 S0\n{% else %}{% for tool in range(printer_profile.extruder.count) %}M104 T{{ tool }} S0\n{% endfor %}{% endif %}'})
- class octoprint.schema.config.scripts.ScriptsConfig(*, gcode: GcodeScriptsConfig = GcodeScriptsConfig(afterPrinterConnected=None, beforePrinterDisconnected=None, beforePrintStarted=None, afterPrintCancelled="; disable motors\nM84\n\n;disable all heaters\n{% snippet 'disable_hotends' %}\n{% snippet 'disable_bed' %}\n;disable fan\nM106 S0", afterPrintDone=None, beforePrintPaused=None, afterPrintResumed=None, beforeToolChange=None, afterToolChange=None, snippets={'disable_hotends': '{% if printer_profile.extruder.sharedNozzle %}M104 T0 S0\n{% else %}{% for tool in range(printer_profile.extruder.count) %}M104 T{{ tool }} S0\n{% endfor %}{% endif %}', 'disable_bed': '{% if printer_profile.heatedBed %}M140 S0\n{% endif %}'}))
- gcode: GcodeScriptsConfig
- class octoprint.schema.config.serial.AlwaysDetectNeverEnum(value)
An enumeration.
- always = 'always'
- detect = 'detect'
- never = 'never'
- class octoprint.schema.config.serial.InfoWarnNeverEnum(value)
An enumeration.
- info = 'info'
- never = 'never'
- warn = 'warn'
- class octoprint.schema.config.serial.SerialCapabilities(*, autoreport_temp: bool = True, autoreport_sdstatus: bool = True, autoreport_pos: bool = True, busy_protocol: bool = True, emergency_parser: bool = True, extended_m20: bool = True, lfn_write: bool = True)
- autoreport_pos: bool
Whether to enable position autoreport in the firmware if its support is detected
- autoreport_sdstatus: bool
Whether to enable SD printing autoreport in the firmware if its support is detected
- autoreport_temp: bool
Whether to enable temperature autoreport in the firmware if its support is detected
- busy_protocol: bool
Whether to shorten the communication timeout if the firmware seems to support the busy protocol
- emergency_parser: bool
Whether to send emergency commands out of band if the firmware seems to support the emergency parser
- class octoprint.schema.config.serial.SerialConfig(*, port: Optional[str] = None, baudrate: Optional[int] = None, exclusive: bool = True, lowLatency: bool = False, autoconnect: bool = False, autorefresh: bool = True, autorefreshInterval: int = 1, log: bool = False, timeout: SerialTimeoutConfig = SerialTimeoutConfig(detectionFirst=10.0, detectionConsecutive=2.0, connection=10.0, communication=30.0, communicationBusy=3.0, temperature=5.0, temperatureTargetSet=2.0, temperatureAutoreport=2.0, sdStatus=1.0, sdStatusAutoreport=1.0, posAutoreport=5.0, resendOk=0.5, baudrateDetectionPause=1.0, positionLogWait=10.0), maxCommunicationTimeouts: SerialMaxTimeouts = SerialMaxTimeouts(idle=2, printing=5, long=5), maxWritePasses: int = 5, additionalPorts: List[str] = [], additionalBaudrates: List[int] = [], blacklistedPorts: List[str] = [], blacklistedBaudrates: List[int] = [], longRunningCommands: List[str] = ['G4', 'G28', 'G29', 'G30', 'G32', 'M400', 'M226', 'M600'], blockedCommands: List[str] = ['M0', 'M1'], ignoredCommands: List[str] = [], pausingCommands: List[str] = ['M0', 'M1', 'M25'], emergencyCommands: List[str] = ['M112', 'M108', 'M410'], checksumRequiringCommands: List[str] = ['M110'], helloCommand: str = 'M110 N0', disconnectOnErrors: bool = True, ignoreErrorsFromFirmware: bool = False, terminalLogSize: int = 20, lastLineBufferSize: int = 50, logResends: bool = True, supportResendsWithoutOk: AlwaysDetectNeverEnum = 'detect', logPositionOnPause: bool = True, logPositionOnCancel: bool = False, abortHeatupOnCancel: bool = True, waitForStartOnConnect: bool = False, waitToLoadSdFileList: bool = True, alwaysSendChecksum: bool = False, neverSendChecksum: bool = False, sendChecksumWithUnknownCommands: bool = False, unknownCommandsNeedAck: bool = False, sdRelativePath: bool = False, sdAlwaysAvailable: bool = False, sdLowerCase: bool = False, sdCancelCommand: str = 'M25', maxNotSdPrinting: int = 2, swallowOkAfterResend: bool = True, repetierTargetTemp: bool = False, externalHeatupDetection: bool = True, supportWait: bool = True, ignoreIdenticalResends: bool = False, identicalResendsCountdown: int = 7, supportFAsCommand: bool = False, firmwareDetection: bool = True, blockWhileDwelling: bool = False, useParityWorkaround: AlwaysDetectNeverEnum = 'detect', maxConsecutiveResends: int = 10, sendM112OnError: bool = True, disableSdPrintingDetection: bool = False, ackMax: int = 1, sanityCheckTools: bool = True, notifySuppressedCommands: InfoWarnNeverEnum = 'warn', capabilities: SerialCapabilities = SerialCapabilities(autoreport_temp=True, autoreport_sdstatus=True, autoreport_pos=True, busy_protocol=True, emergency_parser=True, extended_m20=True, lfn_write=True), resendRatioThreshold: int = 10, resendRatioStart: int = 100, ignoreEmptyPorts: bool = False, encoding: str = 'ascii', enableShutdownActionCommand: bool = False, triggerOkForM29: bool = True)
-
- additionalBaudrates: List[int]
Use this to define additional baud rates to offer for connecting to serial ports. Must be a valid integer
- additionalPorts: List[str]
//docs.python.org/3/library/glob.html)
- Type
Use this to define additional patterns to consider for serial port listing. Must be a valid [“glob” pattern](http
- alwaysSendChecksum: bool
Specifies whether OctoPrint should send linenumber + checksum with every printer command. Needed for successful communication with Repetier firmware.
- autorefresh: bool
Whether to automatically refresh the port list while no connection is established
- autorefreshInterval: int
Interval in seconds at which to refresh the port list while no connection is established
- baudrate: Optional[int]
The default baudrate to use to connect to the printer. If unset or set to 0, the baudrate will be auto-detected.
- blockWhileDwelling: bool
Whether to block all sending to the printer while a G4 (dwell) command is active (true, repetier) or not (false).
- blockedCommands: List[str]
Commands which should not be sent to the printer, e.g. because they are known to block serial communication until physical interaction with the printer as is the case on most firmwares with the default M0 and M1.
- capabilities: SerialCapabilities
- enableShutdownActionCommand: bool
Whether to enable support for the shutdown action command, allowing the printer to shut down OctoPrint and the system it’s running on.
- encoding: str
//docs.python.org/3/library/codecs.html#standard-encodings).
- Type
Encoding to use when talking to a machine. ascii limits access to characters 0-127, latin_1 enables access to the “extended” ascii characters 0-255. Other values can be used, see [Python’s standard encodings](https
- externalHeatupDetection: bool
Whether to enable external heatup detection (to detect heatup triggered e.g. through the printer’s LCD panel or while printing from SD) or not. Causes issues with Repetier’s “first ok then response” approach to communication, so disable for printers running Repetier firmware.
- firmwareDetection: bool
Whether to attempt to auto detect the firmware of the printer and adjust settings accordingly (true) or not and rely on manual configuration (false).
- identicalResendsCountdown: int
If ignoreIdenticalResends is true, how many consecutive identical resends to ignore.
- ignoreIdenticalResends: bool
Whether to ignore identical resends from the printer (true, repetier) or not (false).
- ignoredCommands: List[str]
Commands which should not be sent to the printer and just silently ignored. An example of when you may wish to use this could be useful if you wish to manually change a filament on M600, by using that as a Pausing command.
- log: bool
might decrease performance)
- Type
Whether to log whole communication to serial.log (warning
- logResends: bool
Whether to log resends to octoprint.log or not. Invaluable debug tool without performance impact, leave on if possible please.
- longRunningCommands: List[str]
Commands which are known to take a long time to be acknowledged by the firmware, e.g. homing, dwelling, auto leveling etc.
- maxCommunicationTimeouts: SerialMaxTimeouts
- maxWritePasses: int
Maximum number of write attempts to serial during which nothing can be written before the communication with the printer is considered dead and OctoPrint will disconnect with an error
- notifySuppressedCommands: InfoWarnNeverEnum
- port: Optional[str]
The default port to use to connect to the printer. If unset or set to AUTO, the port will be auto-detected.
- repetierTargetTemp: bool
<temperature>` instead of attaching that information to the regular M105 responses.
- Type
Whether the printer sends repetier style target temperatures in the format `TargetExtr0
- resendRatioThreshold: int
Percentage of resend requests among all sent lines that should be considered critical.
- sdAlwaysAvailable: bool
Whether to always assume that an SD card is present in the printer. Needed by some firmwares which don’t report the SD card status properly.
- sendChecksumWithUnknownCommands: bool
Specifies whether OctoPrint should also send linenumber + checksum with commands that are not detected as valid GCODE (as in, they do not match the regular expression ^s*([GM]d+|T)).
- supportFAsCommand: bool
Whether to support F on its own as a valid GCODE command (true) or not (false).
- supportResendsWithoutOk: AlwaysDetectNeverEnum
Whether to support resends without follow-up ok or not.
- timeout: SerialTimeoutConfig
Timeouts used for the serial connection to the printer, you might want to adjust these if you are experiencing connection problems
- triggerOkForM29: bool
Whether to automatically trigger an ok for M29 (a lot of versions of this command are buggy and the response skips on the ok).
- unknownCommandsNeedAck: bool
Specifies whether OctoPrint should also use up acknowledgments (ok) for commands that are not detected as valid GCODE (as in, they do not match the regular expression ^s*([GM]d+|T)).
- useParityWorkaround: AlwaysDetectNeverEnum
- class octoprint.schema.config.serial.SerialMaxTimeouts(*, idle: int = 2, printing: int = 5, long: int = 5)
- class octoprint.schema.config.serial.SerialTimeoutConfig(*, detectionFirst: float = 10.0, detectionConsecutive: float = 2.0, connection: float = 10.0, communication: float = 30.0, communicationBusy: float = 3.0, temperature: float = 5.0, temperatureTargetSet: float = 2.0, temperatureAutoreport: float = 2.0, sdStatus: float = 1.0, sdStatusAutoreport: float = 1.0, posAutoreport: float = 5.0, resendOk: float = 0.5, baudrateDetectionPause: float = 1.0, positionLogWait: float = 10.0)
- class octoprint.schema.config.server.CommandsConfig(*, systemShutdownCommand: Optional[str] = None, systemRestartCommand: Optional[str] = None, serverRestartCommand: Optional[str] = None, localPipCommand: Optional[str] = None)
- localPipCommand: Optional[str]
pip command associated with OctoPrint, used for installing plugins and updates, if unset (default) the command will be autodetected based on the current python executable - unless you have a really special setup this is the right way to do it and there should be no need to ever touch this setting.
- class octoprint.schema.config.server.CookiesConfig(*, secure: bool = False, samesite: Optional[SameSiteEnum] = SameSiteEnum.lax)
- samesite: Optional[SameSiteEnum]
//www.chromestatus.com/feature/5088147346030592), [“Feature: Reject insecure SameSite=None cookies”](https://www.chromestatus.com/feature/5633521622188032) and [issue #3482](https://github.com/OctoPrint/OctoPrint/issues/3482).
- Type
SameSite setting to use on the cookies. Possible values are None, Lax and Strict. Defaults to Lax. Be advised that if forced unset, this has security implications as many browsers now default to Lax unless you configure cookies to be set with Secure flag set, explicitly set SameSite setting here and also serve OctoPrint over https. The Lax setting is known to cause with embedding OctoPrint in frames. See also [“Feature
- Type
Cookies default to SameSite=Lax”](https
- class octoprint.schema.config.server.DiskspaceConfig(*, warning: int = 524288000, critical: int = 209715200)
- class octoprint.schema.config.server.IpCheckConfig(*, enabled: bool = True, trustedSubnets: List[str] = [])
- class octoprint.schema.config.server.OnlineCheckConfig(*, enabled: Optional[bool] = None, interval: int = 900, host: str = '1.1.1.1', port: int = 53, name: str = 'octoprint.org')
- enabled: Optional[bool]
Whether the online check is enabled. Ships unset, the user will be asked to make a decision as part of the setup wizard.
- class octoprint.schema.config.server.PluginBlacklistConfig(*, enabled: Optional[bool] = None, url: str = 'https://plugins.octoprint.org/blacklist.json', ttl: int = 900, timeout: float = 3.05)
- class octoprint.schema.config.server.PreemptiveCacheConfig(*, exceptions: List[str] = [], until: int = 7)
- class octoprint.schema.config.server.ReverseProxyConfig(*, prefixHeader: Optional[str] = None, schemeHeader: Optional[str] = None, hostHeader: Optional[str] = None, serverHeader: Optional[str] = None, portHeader: Optional[str] = None, prefixFallback: Optional[str] = None, schemeFallback: Optional[str] = None, hostFallback: Optional[str] = None, serverFallback: Optional[str] = None, portFallback: Optional[str] = None, trustedDownstream: List[str] = [])
- hostFallback: Optional[str]
Use this option to define an optional forced host under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy with a different hostname than OctoPrint itself but can’t configure said reverse proxy to send a host HTTP header (X-Forwarded-Host by default, see above) with forwarded requests.
- hostHeader: Optional[str]
The request header from which to determine the host under which OctoPrint is served by the reverse proxy.
- prefixFallback: Optional[str]
Use this option to define an optional URL prefix (with a leading /, so absolute to your server’s root) under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy under a different root endpoint than / and can’t configure said reverse proxy to send a prefix HTTP header (X-Script-Name by default, see above) with forwarded requests.
- prefixHeader: Optional[str]
The request header from which to determine the URL prefix under which OctoPrint is served by the reverse proxy.
- schemeFallback: Optional[str]
Use this option to define an optional forced scheme (http or https) under which to run OctoPrint. This should only be needed if you want to run OctoPrint behind a reverse proxy that also does HTTPS determination but can’t configure said reverse proxy to send a scheme HTTP header (X-Scheme by default, see above) with forwarded requests.
- schemeHeader: Optional[str]
The request header from which to determine the scheme (http or https) under which a specific request to OctoPrint was made to the reverse proxy.
- trustedDownstream: List[str]
List of trusted downstream servers for which to ignore the IP address when trying to determine the connecting client’s IP address. If you have OctoPrint behind more than one reverse proxy you should add their IPs here so that they won’t be interpreted as the client’s IP. One reverse proxy will be handled correctly by default.
- class octoprint.schema.config.server.SameSiteEnum(value)
An enumeration.
- lax = 'Lax'
- none = 'None'
- strict = 'Strict'
- class octoprint.schema.config.server.ServerConfig(*, host: ~typing.Optional[str] = None, port: int = 5000, firstRun: bool = True, startOnceInSafeMode: bool = False, ignoreIncompleteStartup: bool = False, seenWizards: ~typing.Dict[str, str] = {}, secretKey: ~typing.Optional[str] = None, heartbeat: int = 900, reverseProxy: ~octoprint.schema.config.server.ReverseProxyConfig = ReverseProxyConfig(prefixHeader=None, schemeHeader=None, hostHeader=None, serverHeader=None, portHeader=None, prefixFallback=None, schemeFallback=None, hostFallback=None, serverFallback=None, portFallback=None, trustedDownstream=[]), uploads: ~octoprint.schema.config.server.UploadsConfig = UploadsConfig(maxSize=1073741824, nameSuffix='name', pathSuffix='path'), maxSize: int = 102400, commands: ~octoprint.schema.config.server.CommandsConfig = CommandsConfig(systemShutdownCommand=None, systemRestartCommand=None, serverRestartCommand=None, localPipCommand=None), onlineCheck: ~octoprint.schema.config.server.OnlineCheckConfig = OnlineCheckConfig(enabled=None, interval=900, host='1.1.1.1', port=53, name='octoprint.org'), pluginBlacklist: ~octoprint.schema.config.server.PluginBlacklistConfig = PluginBlacklistConfig(enabled=None, url='https://plugins.octoprint.org/blacklist.json', ttl=900, timeout=3.05), diskspace: ~octoprint.schema.config.server.DiskspaceConfig = DiskspaceConfig(warning=524288000, critical=209715200), preemptiveCache: ~octoprint.schema.config.server.PreemptiveCacheConfig = PreemptiveCacheConfig(exceptions=[], until=7), ipCheck: ~octoprint.schema.config.server.IpCheckConfig = IpCheckConfig(enabled=True, trustedSubnets=[]), allowFraming: bool = False, cookies: ~octoprint.schema.config.server.CookiesConfig = CookiesConfig(secure=False, samesite=<SameSiteEnum.lax: 'Lax'>), allowedLoginRedirectPaths: ~typing.List[str] = [])
- allowFraming: bool
Whether to allow OctoPrint to be embedded in a frame or not. Note that depending on your setup you might have to set SameSite to None, Secure to true and serve OctoPrint through a reverse proxy that enables https for cookies and thus logging in to work.
- allowedLoginRedirectPaths: List[str]
List of paths that are allowed to be used as redirect targets for the login page, in addition to the default ones (/, /recovery/ and /plugin/appkeys/auth/)
- commands: CommandsConfig
Commands to restart/shutdown octoprint or the system it’s running on.
- cookies: CookiesConfig
Settings for further configuration of the cookies that OctoPrint sets (login, remember me, …).
- diskspace: DiskspaceConfig
Settings of when to display what disk space warning.
- firstRun: bool
If this option is true, OctoPrint will show the First Run wizard and set the setting to false after that completes.
- host: Optional[str]
Use this option to define the host to which to bind the server. If unset, OctoPrint will attempt to bind on all available interfaces, IPv4 and v6 unless either is disabled.
- ignoreIncompleteStartup: bool
Set this to true to make OctoPrint ignore incomplete startups. Helpful for development.
- ipCheck: IpCheckConfig
Configuration of the client IP check to warn about connections from external networks.
- onlineCheck: OnlineCheckConfig
Configuration of the regular online connectivity check.
- pluginBlacklist: PluginBlacklistConfig
Configuration of the plugin blacklist.
- preemptiveCache: PreemptiveCacheConfig
Configuration of the preemptive cache.
- reverseProxy: ReverseProxyConfig
//community.octoprint.org/t/reverse-proxy-configuration-examples/1107). These are necessary in order to make OctoPrint generate correct external URLs so that AJAX requests and download URLs work, and so that client IPs are read correctly.
- Type
Settings if OctoPrint is running behind a reverse proxy (haproxy, nginx, apache, …) that doesn’t correctly set the [required headers](https
- secretKey: Optional[str]
Secret key for encrypting cookies and such, randomly generated on first run.
- startOnceInSafeMode: bool
If this option is true, OctoPrint will enable safe mode on the next server start and reset the setting to false
- uploads: UploadsConfig
Settings for file uploads to OctoPrint, such as maximum allowed file size and header suffixes to use for streaming uploads. OctoPrint does some nifty things internally in order to allow streaming of large file uploads to the application rather than just storing them in memory. For that it needs to do some rewriting of the incoming upload HTTP requests, storing the uploaded file to a temporary location on disk and then sending an internal request to the application containing the original filename and the location of the temporary file.
- class octoprint.schema.config.server.UploadsConfig(*, maxSize: int = 1073741824, nameSuffix: str = 'name', pathSuffix: str = 'path')
- class octoprint.schema.config.slicing.SlicingConfig(*, enabled: bool = True, defaultSlicer: Optional[str] = None, defaultProfiles: Dict[str, str] = {})
- class octoprint.schema.config.system.ActionConfig(*, action: str, name: Optional[str] = None, command: Optional[str] = None, confirm: Optional[str] = None, **extra_data: Any)
- action: str
The identifier used internally to identify the action. Set to divider to generate a divider in the menu.
- class octoprint.schema.config.system.SystemConfig(*, actions: List[ActionConfig] = [])
- actions: List[ActionConfig]
A list of system actions to show in the UI.
- class octoprint.schema.config.temperature.TemperatureConfig(*, profiles: List[TemperatureProfile] = [TemperatureProfile(name='ABS', extruder=210, bed=100), TemperatureProfile(name='PLA', extruder=180, bed=60)], cutoff: int = 30, sendAutomatically: bool = False, sendAutomaticallyAfter: int = 1)
-
- profiles: List[TemperatureProfile]
Temperature profiles to offer in the UI for quick pre-heating.
- class octoprint.schema.config.temperature.TemperatureProfile(*, name: str, extruder: int, bed: int)
- class octoprint.schema.config.webcam.TimelapseConfig(*, type: TimelapseTypeEnum = TimelapseTypeEnum.off, fps: int = 25, postRoll: int = 0, options: TimelapseOptions = TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None))
-
- options: TimelapseOptions
Additional options depending on the timelapse type.
- postRoll: int
The number of seconds in the rendered video to add after a finished print. The exact way how the additional images will be recorded depends on timelapse type. zchange timelapses will take one final picture and add it fps * postRoll times. timed timelapses continue to record just like at the beginning, so the recording will continue another fps * postRoll * interval seconds. This behaviour can be overridden by setting the capturePostRoll option to false, in which case the post roll will be created identically to zchange mode.
- type: TimelapseTypeEnum
The timelapse type.
- class octoprint.schema.config.webcam.TimelapseOptions(*, interval: Optional[int] = None, capturePostRoll: Optional[bool] = None, retractionZHop: Optional[float] = None)
- capturePostRoll: Optional[bool]
Whether to capture the snapshots for the post roll (true) or just copy the last captured snapshot from the print over and over again (false).
- Type
timed timelapses only
- class octoprint.schema.config.webcam.TimelapseTypeEnum(value)
An enumeration.
- off = 'off'
- timed = 'timed'
- zchange = 'zchange'
- class octoprint.schema.config.webcam.WebcamConfig(*, webcamEnabled: bool = True, timelapseEnabled: bool = True, ffmpeg: ~typing.Optional[str] = None, ffmpegThreads: int = 1, ffmpegVideoCodec: str = 'libx264', bitrate: str = '10000k', watermark: bool = True, ffmpegCommandline: str = '{ffmpeg} -framerate {fps} -i "{input}" -vcodec {videocodec} -threads {threads} -b:v {bitrate} -f {containerformat} -y {filters} "{output}"', ffmpegThumbnailCommandline: str = '{ffmpeg} -sseof -1 -i "{input}" -update 1 -q:v 0.7 "{output}"', timelapse: ~octoprint.schema.config.webcam.TimelapseConfig = TimelapseConfig(type=<TimelapseTypeEnum.off: 'off'>, fps=25, postRoll=0, options=TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None)), cleanTmpAfterDays: int = 7, defaultWebcam: str = 'classic', snapshotWebcam: str = 'classic')
- bitrate: str
The bitrate to use for rendering the timelapse video. This gets directly passed to ffmpeg.
- ffmpeg: Optional[str]
Path to ffmpeg binary to use for creating timelapse recordings. Timelapse support will be disabled if not set.
- timelapse: TimelapseConfig
The default timelapse settings.
- timelapseEnabled: bool
Use this option to enable timelapse support via snapshot, e.g. via MJPG-Streamer. Timelapse support will be disabled if not set.
octoprint.schema.webcam
- class octoprint.schema.webcam.RatioEnum(value)
An enumeration.
- four_three = '4:3'
- sixteen_nine = '16:9'
- class octoprint.schema.webcam.Webcam(*, name: str, displayName: str, canSnapshot: bool = False, snapshotDisplay: str = None, flipH: bool = False, flipV: bool = False, rotate90: bool = False, extras: dict = {}, compat: Optional[WebcamCompatibility] = None)
-
- compat: Optional[WebcamCompatibility]
A compatibility configuration to allow older clients to make use of this webcam
- class octoprint.schema.webcam.WebcamCompatibility(*, streamTimeout: int = 5, streamRatio: RatioEnum = RatioEnum.sixteen_nine, streamWebrtcIceServers: List[str] = ['stun:stun.l.google.com:19302'], cacheBuster: bool = False, stream: str, snapshot: str = None, snapshotTimeout: int = 5, snapshotSslValidation: bool = True)