lemonfiber plugins

Plugins a person has read, for your lemonfiber stack. A plugin adds a service to the stack lemonfiber runs for you: lemonfiber writes its container, puts it on the stack’s dashboard and, for a service the household uses, behind the stack’s proxy, and adds its checks to lemonfiber doctor. This list is where you find the ones somebody has reviewed.

The plugins

Plugin	What it gives you	Reviewed revision
Komga	Read comics, manga and digital magazines in a browser, and on the reading apps you already use	plugins/komga.toml
Uptime Kuma	Watch the services and connections your stack depends on, and see which one stopped answering	plugins/uptime-kuma.toml

Each plugin’s own README says what it needs, what it changes on your machine, what it sends anywhere, and how to install, update and remove it.

Installing one

No lemonfiber release can install the plugins listed here yet. Each adds a service, so each asks lemonfiber to add a service and watch its health (service.add and service.health.http). lemonfiber 0.16.0 offers a plugin neither, and refuses the install by naming both. The commands below are how an install is made; --dry-run shows the refusal and writes nothing.

lemonfiber 0.16.0 installs a plugin from a directory on your machine. Get a copy of the plugin’s repository at the revision listed here, then install it:

git clone https://github.com/lemonfiber/plugin-komga.git
git -C plugin-komga checkout <revision from plugins/komga.toml>
lemonfiber plugin install ./plugin-komga --dry-run
lemonfiber plugin install ./plugin-komga

Keep the ./: it marks a directory on this machine rather than the name of a plugin in this catalogue. lemonfiber 0.15.0 and earlier have no lemonfiber plugin commands.

A plugin installed from a directory is recorded as unreviewed, even at the revision listed here, and lemonfiber plugin installed says so for as long as it is installed. An install is recorded as reviewed only when lemonfiber resolves it by name through a signed index attached to a release of this repository. This repository has published no release, so there is no such index yet.

Installing a plugin covers every way to install, update and remove one. Nothing here is read when a plugin is updated or runs, and every plugin is checked the same way wherever it came from.

What “reviewed” means

Every plugin listed here has passed two things, at the exact revision listed:

• Automatic checks. Its manifest is held to the schema, capabilities and extension points lemonfiber publishes, every proof it declares is run against the responses it recorded from its service, and every place it declares it may reach is checked. A registration failing any of it is refused.
• A person reading it. Somebody read the plugin at that revision and accepted it.

A review is of the plugin, not of the software it installs. A container image is not something anybody can read line by line, which is why every plugin pins its image to one exact build rather than a name its publisher could move.

The revision is a full commit, so what you install at that commit is what was reviewed.

Getting help

• A question: ask on Discord.
• Something wrong with a plugin: open an issue on that plugin’s repository.
• Something wrong with this list: open an issue on this repository.

Licence

The registry data in this repository is under the Hippocratic License 3.0 (HL3-CORE); see LICENSE. Each registered plugin carries its own licence in its own repository.

Adding a plugin to this list

How to register a plugin, and what CI checks on a registration: docs/development.md.