Skip to content

jt196/vanilla-cookbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

909 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vanilla Cookbook

For a full getting started guide, read the docs.

Contributing: Technical Contributing Guide

Roadmap: See our Project Kanban for what's being worked on, and what's coming up.

Recipe Home Recipe List Recipe View

Overview

Vanilla Cookbook is a self hosted recipe manager. It is designed with complexity under the hood, keeping the user experience as uncluttered, simply vanilla as possible.

Most of the web's recipes are written without much thought to a consistent language or structure. Many self-hosted apps go down the structuring route, automating, or asking the user to organise their data. This can lead to cluttered and complex interfaces, meaning you have to work more, just to get cooking. The philosophy behind Vanilla is to do most of that work for the user. You should be able to get cooking with a few clicks.

Development

Vanilla is built with the assistance of AI tools but it is not vibe coded. I'm a dev with 5+ years experience, and mostly know what I'm doing. All the basic architecture has been hand built, and every change that is made is reviewed and tested before release. As this is a spare time project, I honestly don't have the time to build it without the use of AI tools.

Smart Ingredient Display

All based on text string parsing, little or no work to do for the user.

Original Ingredient Strings

The following ingredients are based on this Spruce Eats recipe. No steps other than importing the recipe were taken.

These are the original ingredients (click on Original):

volumetric-conversion-original

Parsed Ingredient Strings

Default display (user units set to metric, display symbols):

Note:

  • Scaling of ingredients
  • Separation out of instructions
  • Quantity/Unit/Ingredient structure
  • Badges (To Serve, also Approx/To Taste/Optional)
  • Cups have been translated to grams

volumetric-conversion-simple

Ingredient Matches Displayed

Volumetric ingredient matches displayed (click on Match):

volumetric-conversion-shown

Features

Unit Conversion

Smart conversion from US Volumetric to imperial and metric weight. Thousands of ingredients supported in this conversion. Inline temperature conversion, fractions and ranges are also supported. Docs

Recipe Scaling

Scale your recipe ingredients. No complicated data entry, it's all done for you, and stored in the original text format.

Nutrition Parsing

Nutrition text is parsed and displayed in a structured table, with per-serving detection and scale-aware values when applicable. Docs

Control Your Data

Multiple import formats supported, exports supported. Docs

Scraping Recipes

Scrape recipes using a browser bookmarklet or simply paste a URL in. Hundreds of sites supported. Docs

For developer-facing scraping internals and the current compatibility matrix, see Scraping Flow and Scrape Compatibility.

LLM Assist

Add an LLM API key to activate these features. Google, OpenAI, Anthropic and Ollama currently supported.

Docs

  • Scrape Assist
    • LLM parses the HTML of a page when Schema.org data absent or malformed
    • text analysis - paste in text for saving
  • Recipe tweak
    • Messy ingredient tidy up - trimming the fat of those lengthy ingredient strings
    • Directions summarise. Look dude, I know how to boil an egg
  • Translate Recipe
    • Detects recipe language
    • Offers translation if recipe language is different.
  • Recipe generate from prompt
    • Build a new recipe from a prompt, e.g. "Original pesto genovese"
  • Image Analysis
    • Drop up to three photos of your next recipe and it'll parse it into the correct form
  • Semantic Search
    • Not just fuzzy search but associative meaning. "Japanese" will throw up noodles, miso etc.
    • Docs

Progressive Web App

Install on your mobile from a browser. Docs

Share URL via browser to scrape a recipe, or select text and share to parse text.

Shopping List

  • Simple but useable shopping list. Add from your recipes, list history, stats. Docs

Cooking Logs

Log when you've cooked a recipe.

  • Calendar view
  • Recipe view
  • Saves log notes and scaling
  • Recook a recipe with previous scaling

Docs

User Management

User authentication is supported. You can manage users, turn on/off registration & site-wide privacy, specify password strength. Optional OAuth login with GitHub, Google, or any OpenID Connect provider (Authentik, Keycloak, etc.). Docs

Automated Database Backups

Docker installations include automatic backups to protect your recipe data:

  • Scheduled backups: Weekly backups run every Sunday at 3am by default, keeping the 6 most recent backups (6 weeks of history). Configurable via BACKUP_CRON_SCHEDULE in .env (supports standard cron syntax for daily, monthly, or custom schedules).
  • Pre-migration backups: Automatic backup created before any database schema migrations to ensure safe upgrades.
  • Retention management: Configure how many scheduled backups to keep with BACKUP_RETENTION_COUNT in .env (default: 6).
  • Accessible backups: All backups are stored in your mounted ./db folder alongside your active database:
    • scheduled-backup-YYYYMMDD-HHMMSS.sqlite - Regular scheduled backups (auto-cleaned)
    • migration-YYYYMMDD-HHMMSS.sqlite - Pre-migration backups (preserved)

After changing backup settings, restart the container: docker-compose restart

Public Recipes

Recipes and your personal cookbook can be made public, so you can share them with friends and family. Fork (duplicate - geddit) another member's recipe, or just favourite it to see it in your own feed.

Easy Installation

Designed to be as easy and stress free to set up as possible. Docker or local node instance.

Multiple Language Ingredient Parsing

Multiple languages supported for ingredient parsing. Docs

Localized UI

The app UI now ships with locale files for the same language set as the ingredient parser, with English fallback if a translation key is missing. User language can be changed in recipe settings and the app refreshes into the selected locale immediately after save.

Installation

Docker set up is dead simple. Single container, portable SQLite database.

Docker

  1. In your project directory, create the .env and docker-compose.yml files using the respective .template files in the repo root:

    curl -o .env https://raw.githubusercontent.com/jt196/vanilla-cookbook/main/.env.template
    curl -o docker-compose.yml https://raw.githubusercontent.com/jt196/vanilla-cookbook/main/docker-compose.yml.template
  2. In the .env file

    • Change the ORIGIN to the URL it's going to be hosted on. If you get any login CORS messages, this not being set correctly will be the reason. The default ORIGIN=http://localhost:3000 should work with the default docker-compose.yml file unless you have anything else on that port.
  3. Create db and uploads folders for persistence in your docker folder, make sure the share paths are correct in the docker-compose file: mkdir -p ./db ./uploads

  4. Use :latest tags for bleedin' edge, :stable for stable release.

  5. Run docker-compose up -d

  6. On first run, you'll be prompted to enter Admin user details.

  7. Optional: set PUID and PGID (in your shell or .env) if you want container file ownership to match a specific host user. Defaults are 1000:1000.

Upgrade

  1. Grab the latest image: docker pull jt196/vanilla-cookbook
  2. Check the .env.template and docker-compose.yml.template files haven't been modified. Add any additional fields. The .env is the most likely to change.
  3. If upgrading from an older image that wrote files as root, run the migration guide below before restarting.
  4. From the project directory, run docker-compose up -d or docker compose up -d depending on how you have it installed on your system.

Docker Non-Root Migration Guide

Vanilla Cookbook now runs the app process as a non-root user in the container. Existing installs may need a one-time ownership fix on mounted volumes.

  1. Stop the container:
    • docker compose down
  2. Back up your DB folder:
    • cp -r ./db ./db-backup-$(date +%Y%m%d-%H%M%S)
  3. Start the updated container:
    • docker compose up -d
  4. Validate:
    • docker compose logs -f app and confirm no writable-permission errors
    • create/edit a recipe
    • upload an image
  5. Only if permission errors remain, run a manual ownership fix:
    • PUID=${PUID:-1000} PGID=${PGID:-1000} sudo chown -R "${PUID}:${PGID}" ./db ./uploads
    • then restart: docker compose up -d
  6. Optional: set PUID/PGID if you want a specific host-user mapping:
    • export PUID=$(id -u)
    • export PGID=$(id -g)

Local Docker Testing (No Docker Hub Push Required)

Use this before testing on a remote host.

  1. In docker-compose.yml, switch from image: to:

    build:
      context: .
  2. Build locally:

    • docker compose build --no-cache
  3. Run:

    • docker compose up -d
  4. Optional user-mapping test:

    • PUID=$(id -u) PGID=$(id -g) docker compose up -d
  5. Verify the runtime user and permissions:

    • docker compose exec app id
    • docker compose exec app sh -lc 'touch /app/uploads/images/perm-test && rm /app/uploads/images/perm-test'
  6. Validate upgrade path locally:

    • temporarily create root-owned files in ./db or ./uploads
    • start the container and check logs for permission warnings
    • run the migration guide chown step and confirm the warnings are gone

Reverse Proxy Configuration

If you're running Vanilla Cookbook behind a reverse proxy (nginx, Nginx Proxy Manager, Traefik, etc.), you may need to adjust some settings.

For Nginx / Nginx Proxy Manager, add these settings:

# Required for saving recipes with images (default 1MB is too small)
client_max_body_size 10M;

# Required to prevent 502 errors (SvelteKit sends many preload headers)
proxy_buffer_size 128k;
proxy_buffers 4 256k;
proxy_busy_buffers_size 256k;

Common issues these settings fix:

  • Recipes fail to save (spinner never stops, no error): client_max_body_size too small
  • 502 Bad Gateway on recipe pages: Proxy buffer settings too small

In Nginx Proxy Manager: Edit your proxy host → Advanced → Custom Nginx Configuration, and add the lines above.

In standard Nginx: Add these to your location block or server block for the Vanilla Cookbook site.

Local Dev

Prerequisites: You'll need build tools installed for native module compilation (better-sqlite3)

  • macOS: Xcode Command Line Tools (xcode-select --install)
  • Linux: build-essential package (Ubuntu/Debian: sudo apt-get install build-essential)
  • Windows: Visual Studio Build Tools or windows-build-tools npm package

Setup

  1. Clone the repo and the recipe-ingredient-parser submodule: git clone --recursive https://github.com/jt196/vanilla-cookbook.git
  2. At the root of the project, create the .env file: cp .env.template .env
  3. In the .env file
    1. Set ORIGIN to http://localhost:5173 (dev).
  4. Run it
    • pnpm i (node packages install)
    • pnpm dev:setup (prisma client gen, migration)
    • pnpm dev
  5. You'll be prompted for admin user details on accessing root

About

A deceptively simple recipe manager.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors