https://github.com/octoprint/octoprint-findmyoctoprint

Makes your OctoPrint instance discoverable via `find.octoprint.org`.
https://github.com/octoprint/octoprint-findmyoctoprint

Last synced: 7 months ago
JSON representation

Makes your OctoPrint instance discoverable via `find.octoprint.org`.

• Host: GitHub
• URL: https://github.com/octoprint/octoprint-findmyoctoprint
• Owner: OctoPrint
• License: agpl-3.0
• Created: 2021-05-04T17:02:47.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-05-04T17:07:34.000Z (about 5 years ago)
• Last Synced: 2024-12-29T02:00:29.543Z (over 1 year ago)
• Language: Python
• Size: 23.4 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Find My OctoPrint

Makes your OctoPrint instance discoverable via [find.octoprint.org](http://find.octoprint.org).

## Setup

Install via the bundled [Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)

or manually using this URL:

    https://github.com/OctoPrint/OctoPrint-FindMyOctoPrint/archive/main.zip

**Note:** Requires Python 3.7 or later!

## Configuration

``` yaml

plugins:

  findmyoctoprint:

    # registry endpoint to use, default is https://findd.octoprint.org (sic!)

    url: https://findd.octoprint.org/registry

    # interval for re-registrations after a client has been seen

    interval_client: 300.0

    # interval for re-registrations when no client has been seen yet

    interval_noclient: 60.0

    # instance name if server name is configured

    instance_with_name: "OctoPrint instance \"{name}\""

    # instance name if only the hostname is known

    instance_with_host: "OctoPrint on {host}"

    # paths whose existance will disable the updater

    #

    # can be used to easily disable even before very first startup

    # for privacy reasons

    # disable_if_exists:

    # - /boot/dont_register.txt

    # everything under "public" is taken from the discovery plugin

    # settings if possible but can be overwritten here too

    #

    # public:

    #   uuid: 

    #   scheme: 

    #   port: 

    #   path: 

    #   httpUser: 

    #   httpPass: 

```