OctoPrint 提供了一个用于控制消费级 3D 打印机的快捷 Web 界面。它是自由软件,根据 GNU Affero 通用公共许可证 V3 发布。
其网站可以在 octoprint.org 上找到。
社区论坛位于community.octoprint.org。它还充当中央知识库。
可以在discord.octoprint.org 上找到Discord 服务器的邀请。
可以通过以下方式访问常见问题解答 faq.octoprint.org。
该文档位于 docs.octoprint.org。
可以通过plugins.octoprint.org 访问官方插件存储库。
如果没有社区的财政支持,OctoPrint 的发展就不可能实现。如果您喜欢 OctoPrint,请考虑成为定期支持者!
您当前正在查看 OctoPrint 的源代码存储库。如果您已经安装了它(例如,通过使用 Raspberry Pi 目标发行版 OctoPi)并且只想了解如何使用它,那么您可能对文档更感兴趣。您可能还想订阅加入community.octoprint.org 上的社区论坛,那里有其他活跃用户,他们可能能够帮助您解决您可能遇到的任何问题。
欢迎各种形式的贡献,不仅以代码的形式,还包括官方文档、错误跟踪器中的调试帮助、社区论坛上的其他用户的支持community.octoprint.org或discord上的官方discord .octoprint.org 以及财务方面。
如果您认为 OctoPrint 或其文档有什么不好的地方,请以任何方式帮助使其变得更好,而不仅仅是抱怨 - 毕竟这是一个开源项目:)
有关如何提交错误报告或拉取请求的信息,请参阅项目的贡献指南。
可以在论坛上找到从源代码安装不同操作系统的安装说明。
如果您想在 Raspberry Pi 上运行 OctoPrint,您确实应该看看 OctoPi,它是一个自定义 SD 卡映像,其中包含 OctoPrint 以及依赖项。
无论操作系统和运行时环境如何,基本上应该完成的通用步骤如下(作为普通用户,请不要使用sudo
命令!) - 这假设您已经拥有 Python 3.7+、pip 和 virtualenv 及其在您的系统上设置的依赖项:
virtualenv venv
。如果您想指定使用特定的 python 而不是系统默认的任何版本,您还可以通过--python
参数明确要求,例如virtualenv --python=python3 venv
。./venv/bin/pip install OctoPrint
然后,您可以通过/path/to/OctoPrint/venv/bin/octoprint
启动 OctoPrint 服务器,有关详细信息,请参阅用法。
安装后,请确保遵循首次运行向导并根据需要设置访问控制。
OctoPrint 依赖于一些 python 模块来完成其工作。通过pip
安装 OctoPrint 时会自动安装这些。
OctoPrint 目前支持 Python 3.7、3.8、3.9、3.10、3.11 和 3.12。
通过运行 pip install
pip install OctoPrint
将octoprint
脚本安装在 Python 安装的脚本文件夹中(该文件夹是否位于您的PATH
中,具体取决于您是全局安装 OctoPrint 还是安装到虚拟环境中)。以下使用示例假设octoprint
脚本位于您的PATH
中。
您可以通过启动服务器
octoprint serve
默认情况下,它绑定到端口 5000 上的所有接口(因此将浏览器指向http://127.0.0.1:5000
即可解决问题)。如果要更改它,请使用附加命令行参数host
和port
,它们分别接受要绑定的主机 ip 和数字端口号。例如,如果您希望服务器仅侦听端口 8080 上的本地接口,则命令行将为
octoprint serve --host=127.0.0.1 --port=8080
或者,可以通过配置文件定义要绑定的主机和端口。
如果您想将 OctoPrint 作为守护进程运行(仅在 Linux 上支持),请使用
octoprint daemon {start|stop|restart} [--pid PIDFILE]
如果您不通过--pid PIDFILE
提供自定义 pidfile 位置,它将在/tmp/octoprint.pid
处创建。
您还可以指定配置文件或基本目录(用于基于uploads
、 timelapse
和logs
文件夹),例如:
octoprint serve --config /path/to/another/config.yaml --basedir /path/to/my/basedir
要在安全模式下启动 OctoPrint(这将禁用所有未与 OctoPrint 捆绑在一起的第三方插件),请使用--safe
标志:
octoprint serve --safe
有关可用命令行参数的更多信息,请参阅octoprint --help
。
OctoPrint 还在其源目录中附带了一个run
脚本。您可以调用它来启动服务器。它采用与octoprint
脚本相同的命令行参数。
如果未通过命令行指定,则 OctoPrint 的配置文件config.yaml
应该位于设置文件夹中,该文件夹位于 Linux 上的~/.octoprint
、Windows 上的%APPDATA%/OctoPrint
以及~/Library/Application Support/OctoPrint
MacOS 上的~/Library/Application Support/OctoPrint
。
所有可用配置设置的全面概述可以在文档中找到。请注意,最常用的配置设置也可以从 OctoPrint 的设置对话框中轻松编辑。
BrowserStack 提供跨浏览器测试服务。
分析是在 PyVmMonitor 的帮助下完成的。
错误跟踪由 Sentry 提供支持和赞助。