# PatchFerret

PatchFerret is a self-hostable utility that converts a mixing console show file into a patch list, specification sheet, and wiring topology diagram, exported as PDFs. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/3181/patchferret

## Description

PatchFerret is a self-hostable utility that converts a mixing console show file into a patch list, specification sheet, and wiring topology diagram, exported as PDFs. It runs in your browser (WebAssembly) or on the command line, currently supports the Behringer X32 scene format, and is aimed at live-sound engineers who need printable patch documentation.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

51/100 (Fair), based on 3 of 4 factors.
- Maintained: 91 (last commit 17 days ago)
- Popular: 0 (0 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Official website: https://patchferret.stoatworks-labs.com
- Unraid: https://ca.unraid.net/apps/patchferret-13c4rjr1fnrqw3?q=patchferret
- GitHub: https://github.com/stoatworks-labs/patchferret

## Common questions

### Does the self-hosted image require a build stage?

No. The web/ directory is the committed browser build of the Rust crates, so the image serves whatever is committed and rebuilding is the repository's own job.

### Does a show file leave the machine?

No. The browser build parses and renders entirely in WebAssembly, so there is no upload and no server.

### Can the generated PDFs be loaded back into a console?

No. No output has ever been loaded back into a console, and no conversion between consoles exists yet.

### How is the Behringer X32 adapter validated?

It is written against a real 2,104-line X32 scene file and asserted in CI. The X32 tests cover connector, slot, and channel composition, head-amp indexing across local and AES50 links, and output-source enumeration.

---
Source: Our Local Host (https://ourlocalhost.com/app/3181/patchferret), the self-hosted and open-source app directory.
