OctoPrint配置文件config.yaml详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00949/article/details/148440152

OctoPrint配置文件config.yaml详解

OctoPrint 项目地址: https://gitcode.com/gh_mirrors/oct/OctoPrint

OctoPrint作为一款功能强大的3D打印机控制软件，其核心配置文件config.yaml承载着系统各项功能的配置参数。本文将深入解析该文件的结构与各项配置，帮助用户更好地定制自己的OctoPrint环境。

配置文件基础

config.yaml是OctoPrint的主配置文件，默认位于以下位置：

Linux: ~/.octoprint/config.yaml
Windows: %APPDATA%/OctoPrint/config.yaml
macOS: ~/Library/Application Support/OctoPrint/config.yaml

当配置文件不存在时，用户可手动创建。OctoPrint只会在用户修改了默认设置后才会自动生成此文件。

核心配置模块详解

1. 访问控制配置

accessControl:
  userManager: octoprint.access.users.FilebasedUserManager
  userfile: /path/to/users.yaml
  autologinLocal: false
  autologinAs: someUser
  localNetworks:
  - 127.0.0.0/8
  - 192.168.1.0/24
  trustBasicAuthentication: false
  checkBasicAuthenticationPassword: true
  trustRemoteUser: false
  remoteUserHeader: REMOTE_USER
  addRemoteUsers: false

这部分配置管理用户认证和访问控制：

userManager指定用户管理实现方式
autologinLocal启用本地网络自动登录功能
localNetworks定义被视为"本地"的网络范围
反向代理集成相关设置（trustRemoteUser等）

2. API配置

api:
  enabled: True
  key: ...
  allowCrossOrigin: false
  apps:
    "some.app.identifier:some_version":
      pubkey: <RSA pubkey>
      enabled: true

API相关设置包括：

启用/禁用API
API密钥管理
跨域访问控制
第三方应用密钥配置（已弃用）

3. 界面外观定制

appearance:
  name: My Printer
  color: default
  colorTransparent: false
  showInternalFilename: true
  components:
    order:
      navbar: [...]
      sidebar: [...]
      tab: [...]
      settings: [...]
    disabled:
      navbar: []
      sidebar: []

界面定制功能强大：

打印机名称显示
导航栏颜色设置
组件布局顺序调整
组件禁用功能

实用技巧：通过调整components.order可以完全重新排列界面元素顺序，例如将插件选项卡移动到更显眼的位置。

4. 控制面板配置

controls:
  - name: Fan
    layout: horizontal
    children:
      - name: Enable Fan
        type: parametric_command
        command: M106 S%(speed)s
        input:
          - name: Speed (0-255)
            parameter: speed
            default: 255
      - name: Disable Fan
        type: command
        command: M107

自定义控制面板功能：

支持参数化命令
多种布局方式
子控件嵌套
默认值设置

5. 开发相关配置

devel:
  cache:
    enabled: true
    preemptive: true
  stylesheet: css
  webassets:
    bundle: true
    minify: true
    minify_plugins: false
    clean_on_startup: true
  showLoadingAnimation: true

开发专用设置包括：

缓存控制
样式表预处理选择
资源打包与压缩
加载动画显示

6. 打印时间预估

estimation:
  printTime:
    statsWeighingUntil: 0.5
    validityRange: 0.15
    forceDumbFromPercent: 0.3
    forceDumbAfterMin: 30
    stableThreshold: 60

精细调整打印时间预估算法：

统计权重计算
有效性范围
回退机制
稳定性阈值

7. 事件系统配置

events:
  subscriptions:
    - event: Disconnected
      command: "logger 'Printer got disconnected'"
      type: system
    - event: Connected
      command: M115,M117 printer connected!,G28
      type: gcode
      enabled: False

事件驱动自动化功能：

支持系统命令和G代码
事件类型丰富
调试模式支持
条件执行控制

8. 功能开关

feature:
  gCodeVisualizer: true
  temperatureGraph: true
  sdSupport: true
  keyboardControl: true
  pollWatched: false
  modelSizeDetection: true
  printCancelConfirmation: true

核心功能启用/禁用：

G代码可视化
温度曲线图
SD卡支持
键盘控制
文件监控方式
模型尺寸检测
打印取消确认

9. 目录结构配置

folder:
  uploads: /path/to/upload/folder
  timelapse: /path/to/timelapse/folder
  timelapse_tmp: /path/to/timelapse/tmp/folder
  logs: /path/to/logs/folder
  virtualSd: /path/to/virtualSd/folder
  watched: /path/to/watched/folder
  plugins: /path/to/plugins/folder

自定义存储路径：