Plugin Marketplace
Sign in

Documentation

Prusa Connect extensions/Getting started

What a Connect extension is

What Prusa Connect extensions are, how operators install them and how each release is checked.

All articles

Prusa Connect is a server you run yourself, on a Raspberry Pi, a NAS or a large machine, that talks to your printers with no cloud in between. Its source is on GitHub: prusa3d/prusa-connect. The marketplace pages also call it Connect Local.

An extension adds something to that server: a page in its web app, an integration with another system, or a service that works with the printers. An extension can have two parts, and has at least one of them:

  • A process. A program, usually written in Go, that the server starts, watches and stops. It serves its own routes under the server’s API, and it can store records and publish events.
  • A browser bundle. JavaScript that the Connect web app loads, so the extension can add pages and panels there.

Unlike a PrusaSlicer plugin, the process is native code that runs on the operator’s machine. That is why every Connect release is reviewed by a person before anyone can install it.

The extension id

An extension is named by its module path, for example github.com/acme/spools. The server and the marketplace both turn it into the same id: the host reversed, the label aux, then the rest of the path. github.com/acme/spools becomes com.github.aux.acme.spools.

The id never changes, so keep the module path the same for every release. Ids with “prusa” in them are reserved for Prusa Research.

Installing an extension

An operator opens Settings → Extensions in Prusa Connect. The page lists the extensions this marketplace offers for that server’s version and platform, and installs one with one click. Before anything runs, the install dialog shows what the extension asks for, such as its permissions, its license, and every connection outside Prusa Connect it declares under egress. The operator approves that list or cancels.

On the web, each extension’s page here has an Install in Connect Local button that opens the operator’s own server, which then asks the same questions.

What a release contains

A release is one .tar.gz file:

module.yaml                    the manifest: name, version, license, platforms, what it asks for
spools_linux_amd64             one binary per platform, named <name>_<GOOS>_<GOARCH>
spools_linux_arm64
spools_windows_amd64.exe       .exe on Windows
ui/index.js, ui/locales/…      the browser bundle, when module.yaml has a ui block
checksums.txt                  the SHA-256 of every file above
checksums.txt.sig              your signature over checksums.txt
LICENSE, README.md, CHANGELOG.md   optional

The marketplace stores the file byte for byte. Prusa Connect checks the same SHA-256 and your signature before it installs it. A release built by the marketplace’s builder also carries the source of the commit it was built from, which the marketplace keeps for the review.

What happens after you publish

  1. Checks. The archive is checked automatically:
    • only regular files, with safe names and sizes;
    • module.yaml follows the same rules Prusa Connect applies;
    • every binary is named for a platform the manifest declares, and its header matches that platform;
    • checksums.txt covers every file, and checksums.txt.sig verifies with one of your active keys;
    • two malware scanners find nothing.
  2. Source review. For a release built by the marketplace’s builder, the source is reviewed thoroughly: the program, the bundle as it ships, and every outbound connection, which must be declared under egress in module.yaml. The marketplace also checks that every binary was built from that source and commit.
  3. Review. A person from Prusa reads the evidence and what the extension asks for, then publishes the release or tells you what to change. A finding they accept is accepted in writing, with the reason kept with the release.
  4. Published. The release shows here and in Settings → Extensions of every server whose version fits the range in module.yaml.

A release on the beta channel is never the newest version a server is offered: an operator installs it only by choosing it. Releases from Prusa Research carry the Official badge, and other reviewed releases carry Trusted.

Who can publish

Every author can publish Connect extensions: Publish in the author console offers Prusa Connect extension next to PrusaSlicer plugin. An extension is a native program that runs on the operator’s server with nothing sandboxing it, so every release is built from its source and a person at Prusa reviews it before operators can install it.

What comes next

  1. Become an author and register a signing key.
  2. Build your first extension from the example repository.
  3. Publish it from GitHub Actions, with the marketplace’s builder.