Ansible-OctoPrint

This is an Ansible role that helps you install OctoPrint as a system service on Debian-based systems (like Raspbian or Ubuntu).

Important Note: The configuration file is not handled by this role at the moment. If the state is set to absent, it will be removed. Any restarts are managed through the OctoPrint command line interface.

This role does not provide help or guidance on configuring OctoPrint, Ansible, Linux, or Raspberry Pi. For assistance, please refer to the official documentation for these projects.

Requirements

• A Debian-based system (or similar) with SSH access.
• The Ansible user needs permission to use sudo without entering a password.

Role Variables

Here's a list of configurable variables:

octoprint:
  port: 5000 # The port for OctoPrint
  user: pi # The system user running OctoPrint (must exist beforehand)
  group: pi # The system group running OctoPrint (must exist beforehand)
  version: latest # The version of OctoPrint to install
  state: present # Change to 'absent' to remove all files, configurations, and services
  dir: /srv/octoprint # Directory where OctoPrint will be installed

Examples

To Install the Latest Version of OctoPrint:

    - name: Provision OctoPrint
      hosts: rpi-octoprint
      remote_user: pi
      become: true
      roles:
      - loelkes.octoprint

To Install a Specific Version of OctoPrint:

    - name: Provision OctoPrint
      hosts: rpi-octoprint
      remote_user: pi
      become: true
      vars:
        octoprint:
          version: "1.8.7"
      roles:
      - loelkes.octoprint

To Update OctoPrint While Keeping Existing Configurations:

    - name: Update OctoPrint with existing configuration
      hosts: rpi-octoprint
      remote_user: pi
      become: true
      roles:
      - loelkes.octoprint

To Uninstall OctoPrint and Its Dependencies:

    - name: Uninstall OctoPrint on Raspberry Pi OS
      hosts: rpi-octoprint
      remote_user: pi
      become: true
      vars:
        octoprint:
          state: absent
      roles:
      - loelkes.octoprint

Contributing

For details, check the Contributing Guidelines.

License

This project is licensed under the BSD 2-Clause License.

Changelog

For updates, see the CHANGELOG.md.

Authors

• Christian Lölkes
• [email protected]