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

Settings /api/v1/settings GET /api/v1/settings PATCH /api/v1/settings/mail GET /api/v1/settings/mail DELETE /api/v1/settings/mail PUT /api/v1/settings/mail/test POST

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

ReferenceSettings

Settings

The household-wide settings. Everyone reads them; only the owner changes them.

Get the household settings

Change the household settings

Get the mail configuration

Turn mail off

Configure mail

Send a test mail

With config, tests those unsaved values (a missing password uses the stored one, for the stored host and username only); without, the configuration in force. A refusal by the SMTP server answers 502 with the server's reply.

/public-images/{token}/{imageId}/{file} GET

No session needed, like get-public-recipe. A photo of another recipe, one removed from the recipe, an unknown size and a link that serves nothing answer 404 alike.

/api/v1/settings GET

Get the household settings