octoprint

ansible-octoprint

Release Release Date Last Commit Contributors Open Issues License

Ansible role to deploy OctoPrint as systemd services on Debian (or similar, like Raspbian, Ubuntu).

The configuration file is not managed by this role as of now . It will be deleted if the state is set to absent in the variables. The restart commands are configured through the OctoPrint configuration CLI.

Note: This role and repository should not contain any help or advice on octoprint/ansible/linux/raspberrypi configuration. Please see the manuals for the respective projects for help.

Requirements

Debian or similar host with SSH enabled. The user used for ansible must be able to perform sudo commands without password.

Role Variables

octoprint:
  port: 5000 # Port for OctoPrint
  user: pi # System user running OctoPrint. Must already exist, not managed by this role.
  group: pi # System group running OctoPrint. Must already exist, not managed by this role.
  version: latest # OctoPrint Version.
  state: present # Set to absent to remove all files, configurations and services.
  dir: /srv/octoprint # OctoPrint installation directory.

Examples

To install OctoPrint in the latest version:

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

To install OctoPrint with pinned version:

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

To update OctoPrint, keeping existing configuration and access credentials:

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

To uninstall OctoPrint and all package dependencies:

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