Getting started

Quick start Docker Running the binary Configuration First login

Features

Tour of the app Recipes Comments Importing a recipe Photos Tags and search Servings Cook mode People Mail Editing rights Sharing recipes Settings Import and export Keyboard shortcuts

Operations

Data and backup Updates Reverse proxy Single sign-on

API

Using the API API tokens Connect an AI assistant

Images /api/v1/recipes/{id}/cover PUT /api/v1/recipes/{id}/images POST /api/v1/recipes/{id}/images/order PUT /api/v1/recipes/{id}/images/{imageId} DELETE /images/{recipeId}/{imageId}/{file} GET

Contributing

Releases

Changelog v1.2.0 — Comment on recipes, import them from a link v1.1.0 — Sign in with Google, invite with a link v1.0.0 — Your household's recipes, now stable v1.0.0-rc1 — Your household's recipes, on your own server Roadmap

ReferenceImages

Images

Uploading recipe images and serving them in their rendered sizes.

Choose the cover image

Upload an image (JPEG, PNG or WebP, at most 10 MiB)

Reorder a recipe's images

Delete an image

Read an image in one of its rendered sizes

/api/v1/tags GET

List tags with usage counts

/api/v1/recipes/{id}/cover PUT

Choose the cover image