lemonfiber — the Rust workspace

Lemonfiber

Sets up a self-hosted media stack, runs the part of it you need, and checks that it is actually working.

---

lemonfiber is a command-line tool for running your own media server at home. It installs and wires together open-source services such as Jellyfin, Sonarr, Radarr, Prowlarr and Seerr, then keeps checking them: is the VPN really carrying the torrent traffic, are imports hardlinking instead of copying?

It is for anyone comfortable running Docker who does not want to configure six web interfaces by hand. Everyone else in the house never sees it: they ask for things in Seerr and watch them in Jellyfin.

This repository holds the lemonfiber binary: the command line, a terminal dashboard, and the local web API that the web console and phone app use. It is written in Rust.

Status: before 1.0. What is built lists what works today and what is still planned.

Install

You need:

• macOS or Linux. There is no native Windows build.
• Docker with Compose v2.20 or newer, running.

Install the newest release with its installer. Every release is on the releases page.

curl --proto '=https' --tlsv1.2 -LsSf \
  https://github.com/lemonfiber/lemonfiber/releases/latest/download/lemonfiber-installer.sh | sh

The installer puts lemonfiber in ~/.cargo/bin (or $CARGO_HOME/bin). Check it worked:

$ lemonfiber --version
lemonfiber 0.16.0

Prebuilt archives with checksums, and building from source, are covered in Install lemonfiber.

First run

Run it with nothing configured and it offers to set itself up:

lemonfiber

Setup asks only what it cannot work out itself, tests each credential against the live service, and writes nothing until you confirm a summary. Then:

lemonfiber up tv        # start one part of the stack: search, download, organise TV
lemonfiber ps           # what each service is really doing
lemonfiber doctor       # check the VPN, hardlinks, disk space and more

tv is a form: a named part of the stack. lemonfiber forms lists them all, from search (just find things) to full (everything). Your first stack walks through setup step by step.

Documentation

Everything about using lemonfiber is on docs.lemonfiber.app:

• Running your stack: forms, the services, quality, requests, backups
• When something is wrong: the doctor, and every error code
• Command reference: every command and flag
• The API and the SDKs: build on the local web API

Working on lemonfiber

git clone --recurse-submodules https://github.com/lemonfiber/lemonfiber.git
cd lemonfiber
cargo build --workspace
just ci                 # formatting, lints, tests, spelling; also installs the git hooks

.docs/ explains how the code is laid out and why, starting with the module layout. Every change cites a requirement in the specification; read the contributing guide and AGENTS.md before your first pull request.

To report a vulnerability, follow SECURITY.md. Questions go to Discord.

Licence

Hippocratic License 3.0: source-available and ethical-source, and deliberately not OSI-approved. The licence rationale explains what that means for you. The services lemonfiber runs keep their own open-source licences.

lemonfiber is made by NightWorksIO.

---

 ·