docker version --format 'Server: {{.Server.Version}}'
docker compose version

Server: 29.9.2
Docker Compose version v5.6.1

recipesage/
└── docker-compose.yml

# This config file is for RecipeSage-selfhost config version 2026-10-29, and RecipeSage version 4.1.1.

x-common-env: &common-env
  # === THESE VALUES MUST BE CHANGED ===
  API_PUBLIC_BASE_URL: http://127.0.0.1:8162/api # host+port with /api suffix

  # === THESE VALUES MAY OPTIONALLY BE CHANGED, BUT DO NOT NEED TO BE ===
  GRIP_KEY: recipesage_selfhost # Pushpin is only exposed within the docker network, so you can leave this as-is if desired.
  POSTGRES_DB: recipesage_selfhost # If changing this, make sure to update the DATABASE_URL below accordingly
  POSTGRES_USER: recipesage_selfhost # If changing this, make sure to update the DATABASE_URL below accordingly
  POSTGRES_PASSWORD: recipesage_selfhost # If changing this, make sure to update the DATABASE_URL below accordingly
  DATABASE_URL: postgresql://recipesage_selfhost:recipesage_selfhost@postgres:5432/recipesage_selfhost # Format is: postgresql://USERNAME:PASSWORD@HOST:PORT/DBNAME and must match the variables above
  GROCERY_CATEGORIZER_URL: https://grocery-categorizer.recipesage.com/ # Set to the local grocery-categorizer service if you uncomment it below
  AI_PROVIDER: "openrouter" # Please follow the instructions in the README if you decide to supply a value here
  AI_API_KEY: "" # Please follow the instructions in the README if you decide to supply a value here
  AI_API_BASE_URL: "" # This does not need to be changed unless you are self-hosting your own LLM.
  AI_MODEL_WEBPAGE: google/gemini-2.5-flash-lite # This model is recommended for this purpose
  AI_MODEL_TEXT: google/gemini-2.5-flash-lite # This model is recommended for this purpose
  AI_MODEL_OCR: google/gemini-2.5-flash # This model is recommended for this purpose
  AI_MODEL_DOCUMENT: google/gemini-2.5-flash # This model is recommended for this purpose
  AI_MODEL_MODERATION: google/gemini-2.5-flash # This model is recommended for this purpose
  AI_MODEL_VISION: anthropic/claude-sonnet-4.6 # This model is recommended for this purpose
  AI_MODEL_NUTRITION: google/gemini-2.5-flash-lite # This model is recommended for this purpose
  AI_MODEL_ASSISTANT: anthropic/claude-sonnet-4.6 # Use whatever model you prefer
  AI_MODEL_ASSISTANT_LOW: google/gemini-2.5-flash # Use whatever model you prefer
  SCRAPFLY_API_KEY: "" # Can be provided to bypass CloudFlare anti-bot for better clip from URL support. Or, just use the browser extension instead.

# === Please do not change any values below this line ===

services:
  proxy: # The proxy must not be removed. If needed, point your own proxy to this container, rather than removing this
    container_name: recipesage_proxy
    image: julianpoy/recipesage-selfhost-proxy:2026-08-16
    ports:
    - 8162:80
    depends_on:
      - static
      - api
      - pushpin
    restart: unless-stopped
  static: # Hosts frontend assets
    container_name: recipesage_static
    image: julianpoy/recipesage-selfhost:static-v4.1.1
    restart: unless-stopped
  api: # Hosts backend API
    container_name: recipesage_api
    image: julianpoy/recipesage-selfhost:api-v4.1.1
    depends_on:
      postgres:
        condition: service_healthy
      pushpin:
        condition: service_started
      valkey:
        condition: service_started
    command: ./scripts/selfhost-startup.sh
    environment:
      <<: *common-env
      # Please don't change these environment variables
      ENVIRONMENT: selfhost
      NODE_ENV: selfhost
      NODE_OPTIONS: "--max-old-space-size=400"
      MALLOC_ARENA_MAX: "2"
      FILESYSTEM_STORAGE_PATH: /rs-media
      STORAGE_TYPE: filesystem
      VERBOSE: "false"
      VERSION: selfhost
      POSTGRES_HOST: postgres
      POSTGRES_PORT: "5432"
      POSTGRES_SSL: "false"
      POSTGRES_LOGGING: "false"
      DATABASE_SSL: "false"
      GRIP_URL: http://pushpin:5561/
      JOB_QUEUE_REDIS_HOST: valkey
      STRIPE_SK: "" # Value should not be set.
      GCM_KEYPAIR: "" # Value should not be set.
      SENTRY_DSN: "" # Value should not be set.
      STRIPE_WEBHOOK_SECRET: "" # Value should not be set
    volumes:
      - apimedia:/rs-media
    restart: unless-stopped
  pushpin: # Provides websocket support
    container_name: recipesage_pushpin
    image: julianpoy/pushpin:2023-09-17
    entrypoint: /bin/sh -c
    command:
      [
        'sed -i "s/sig_key=changeme/sig_key=$$GRIP_KEY/" /etc/pushpin/pushpin.conf && echo "* $${TARGET},over_http" > /etc/pushpin/routes && pushpin --merge-output',
      ]
    environment:
      <<: *common-env
      TARGET: api:3000
    restart: unless-stopped
  postgres: # Database
    container_name: recipesage_postgres
    image: postgres:16
    environment:
      <<: *common-env
    volumes:
      - postgresdata:/var/lib/postgresql/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "pg_isready", "-d", "recipesage_selfhost", "-U", "recipesage_selfhost"]
      interval: 5s
      timeout: 5s
      retries: 5
      start_period: 10s
  valkey:
    container_name: recipesage_valkey
    restart: unless-stopped
    image: valkey/valkey

volumes:
  apimedia:
    driver: local
  postgresdata:
    driver: local

docker compose -p recipesage up -d

 Container recipesage_api Running 
 Container recipesage_pushpin Running 
 Container recipesage_postgres Running 
 Container recipesage_valkey Running 
 Container recipesage_proxy Running 
 Container recipesage_static Running 
 Container recipesage_postgres Waiting 
 Container recipesage_postgres Healthy 

docker compose -p recipesage ps --format '{{.Name}} {{.Status}}'

recipesage_api Up 14 minutes
recipesage_postgres Up 14 minutes (healthy)
recipesage_proxy Up 14 minutes
recipesage_pushpin Up 14 minutes
recipesage_static Up 14 minutes
recipesage_valkey Up 14 minutes

==== Running migrations, please wait. ====
Loaded Prisma config from prisma.config.ts.

Prisma schema loaded from packages/prisma/src/prisma.
Datasource "db": PostgreSQL database "recipesage_selfhost", schema "public" at "postgres:5432"

69 migrations found in prisma/migrations

Applying migration `0_init`
Applying migration `20231107015959_default_createdat`
Applying migration `20231112183754_create_assistantmessage`
...

POST /compat/v2/jobs/startExportJob 200 3.829 ms - -
Starting processing job 2 with EXPORT.jsonld
Finished processing job 2
Job queue has drained

docker stats --no-stream --format '{{.Name}} {{.MemUsage}} {{.CPUPerc}}' recipesage_proxy recipesage_static recipesage_api recipesage_pushpin recipesage_postgres recipesage_valkey

recipesage_proxy     6.754MiB / 15.57GiB   0.00%
recipesage_static    6.551MiB / 15.57GiB   0.00%
recipesage_api       516.7MiB / 15.57GiB   0.48%
recipesage_pushpin   35.09MiB / 15.57GiB   0.04%
recipesage_postgres  43.66MiB / 15.57GiB   3.27%
recipesage_valkey    7.27MiB / 15.57GiB    0.10%

curl -s -o /dev/null -w '%{http_code} %{redirect_url}\n' http://127.0.0.1:8162/
curl -s http://127.0.0.1:8162/app/ -o rs_app.html && wc -c rs_app.html
curl -s http://127.0.0.1:8162/app/ | grep -o '<title>[^<]*</title>'
curl -s -o /dev/null -w '%{http_code}\n' http://127.0.0.1:8162/app/login

301 http://127.0.0.1/app/
15217 rs_app.html
<title>RecipeSage</title>
200

curl -s http://127.0.0.1:8162/api/ | head -c 200
curl -s http://127.0.0.1:8162/api/openapi.json -o rs_openapi.json && wc -c rs_openapi.json
python3 -c "import json;d=json.load(open('rs_openapi.json'));print('title:',d['info']['title'],'| version:',d['info']['version'],'| paths:',len(d['paths']))"

<!DOCTYPE html><html><head><title></title><link rel="stylesheet" href="/stylesheets/style.css"></head><body><h1>RecipeSage API</h1><p>Welcome to the RecipeSage API<br>Usage of the RecipeSage API is free for personal, non-commercial use.
403081 rs_openapi.json
title: RecipeSage API | version: selfhost | paths: 144

curl -s -X POST http://127.0.0.1:8162/api/compat/v2/users/register \
  -H 'Content-Type: application/json' \
  -d '{"name":"admin","email":"admin@example.com","password":"q1w2e3r4"}'

{"token":"490d2318d743839953460fe010bc1a0ae5cfe8e2588bde69d74ac436ba1ccc71ef6a928226a9fe822cd4518b7814ccd7","userId":"42754089-a1d9-4e1d-8b04-7df237fbb337","email":"admin@example.com","isNewUser":true}

curl -s http://127.0.0.1:8162/api/compat/v2/users/validateSession -H "Authorization: Bearer $TOKEN"

curl -s -X POST http://127.0.0.1:8162/api/compat/v2/recipes/createRecipe \
  -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{"title":"Pasta Aglio e Olio","description":"Garlic chili pasta","yield":"2 servings",
       "activeTime":"PT10M","totalTime":"PT15M","source":"quzuo G25","url":"","notes":"keep starchy water",
       "instructions":"1. Boil pasta.\n2. Sauté garlic and chili in olive oil.\n3. Toss pasta with garlic oil.",
       "ingredients":"200 g spaghetti\n4 cloves garlic\n1 tsp chili flakes\n60 ml olive oil\n1 bunch parsley",
       "rating":null,"folder":"main","labelIds":[],"imageIds":[]}'

curl -s -X POST http://127.0.0.1:8162/api/compat/v2/recipes/getRecipes \
  -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{"folder":"main","orderBy":"createdAt","orderDirection":"desc","offset":0,"limit":10}'

{"recipes":[{"id":"fb231af7-5993-42d8-9bc8-e6a5862afaea","userId":"42754089-a1d9-4e1d-8b04-7df237fbb337","fromUserId":null,"title":"Pasta Aglio e Olio","description":"Garlic chili pasta","yield":"2 servings","activeTime":"PT10M","totalTime":"PT15M","source":"quzuo G25","url":"","folder":"main","createdAt":"2026-11-01T20:54:59.373Z","updatedAt":"2026-11-01T20:54:59.373Z","lastMadeAt":null,"rating":null,"recipeLabels":[],"recipeImages":[],"fromUser":null,"user":{"id":"42754089-a1d9-4e1d-8b04-7df237fbb337","name":"admin","handle":null,"enableProfile":false,"profileImages":[]}}],"totalCount":1}

curl -s http://127.0.0.1:8162/api/compat/v2/users/getMyStats -H "Authorization: Bearer $TOKEN"

curl -s -X POST http://127.0.0.1:8162/api/compat/v2/shoppingLists/createShoppingList \
  -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{"title":"Weekly Groceries","collaboratorUserIds":[]}'

curl -s -X POST http://127.0.0.1:8162/api/compat/v2/shoppingLists/createShoppingListItem \
  -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{"shoppingListId":"d0e7f44b-e764-435c-96f7-aca6d96bc637","title":"spaghetti","quantity":"200 g","recipeId":"fb231af7-5993-42d8-9bc8-e6a5862afaea","completed":false,"categoryTitle":"Grains"}'

curl -s -X POST http://127.0.0.1:8162/api/compat/v2/users/register \
  -H 'Content-Type: application/json' \
  -d '{"name":"friend","email":"friend@example.com","password":"q1w2e3r4"}'

curl -s -X POST http://127.0.0.1:8162/api/compat/v2/users/createFriendship \
  -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{"friendId":"1404d776-7b7f-4eb3-aa1e-552cd741e585"}'
curl -s -X POST http://127.0.0.1:8162/api/compat/v2/users/createFriendship \
  -H "Authorization: Bearer $FTOKEN" -H 'Content-Type: application/json' \
  -d '{"friendId":"42754089-a1d9-4e1d-8b04-7df237fbb337"}'

curl -s http://127.0.0.1:8162/api/compat/v2/users/getMyFriends -H "Authorization: Bearer $TOKEN"

curl -s -X POST http://127.0.0.1:8162/api/compat/v2/shoppingLists/updateShoppingList \
  -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{"id":"d0e7f44b-e764-435c-96f7-aca6d96bc637","title":"Weekly Groceries","collaboratorUserIds":["1404d776-7b7f-4eb3-aa1e-552cd741e585"]}'

curl -s http://127.0.0.1:8162/api/compat/v2/shoppingLists/getShoppingLists -H "Authorization: Bearer $FTOKEN"

[{"id":"d0e7f44b-e764-435c-96f7-aca6d96bc637","userId":"42754089-a1d9-4e1d-8b04-7df237fbb337","user":{"id":"42754089-a1d9-4e1d-8b04-7df237fbb337","name":"admin"},"collaboratorUsers":[{"user":{"id":"1404d776-7b7f-4eb3-aa1e-552cd741e585","name":"friend"}}],"title":"Weekly Groceries","_count":{"items":1}}]

curl -s -X POST http://127.0.0.1:8162/api/compat/v2/jobs/startExportJob \
  -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
  -d '{"format":"jsonld","recipeIds":["fb231af7-5993-42d8-9bc8-e6a5862afaea"]}'

curl -s "http://127.0.0.1:8162/api/compat/v2/jobs/getJob?id=2e47aa87-0c7d-4b80-a75e-60fb78925c0a" \
  -H "Authorization: Bearer $TOKEN"

{"id":"2e47aa87-0c7d-4b80-a75e-60fb78925c0a","status":"SUCCESS","type":"EXPORT","userId":"42754089-a1d9-4e1d-8b04-7df237fbb337","resultCode":0,"progress":100,"meta":{"exportType":"jsonld","exportScope":"recipeids","exportStorageBucket":"filesystem","exportStorageKey":"dataExport/2026/11/1793566536025-8296230e1b0ade","exportDownloadUrl":"api/images/filesystem/dataExport/2026/11/1793566536025-8296230e1b0ade","recipeIds":["fb231af7-5993-42d8-9bc8-e6a5862afaea"],"language":"en-us"},"createdAt":"2026-11-01T20:55:36.006Z","updatedAt":"2026-11-01T20:55:36.033Z"}

docker exec recipesage_api sh -c 'wc -c "/rs-media/dataExport/2026/11/1793566536025-8296230e1b0ade" && head -c 300 "/rs-media/dataExport/2026/11/1793566536025-8296230e1b0ade"'

778 /rs-media/dataExport/2026/11/1793566536025-8296230e1b0ade
{"recipes":[{"@context":"http://schema.org","@type":"Recipe","identifier":"fb231af7-5993-42d8-9bc8-e6a5862afaea","datePublished":"2026-11-01T20:54:59.373Z","description":"Garlic chili pasta","image":[],"name":"Pasta Aglio e Olio","prepTime":"PT10M","recipeIngredient":["200 g spaghetti","4 cloves gar

curl -s -X POST http://127.0.0.1:8162/api/clip -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' -d '{"url":"https://www.example.com/recipe"}'

docker exec recipesage_postgres psql -U recipesage_selfhost -d recipesage_selfhost \
  -tAc "select count(*) from pg_tables where schemaname='public'"

docker exec recipesage_postgres pg_dump -U recipesage_selfhost recipesage_selfhost | gzip > rs_backup.sql.gz
ls -la rs_backup.sql.gz

docker volume ls | grep recipesage

local     recipesage_apimedia
local     recipesage_postgresdata

# 查看栈状态
docker compose -p recipesage ps

# 跟踪 api 日志（排障主入口）
docker compose -p recipesage logs -f api

# 重启单个服务
docker compose -p recipesage restart api

# 升级：改 compose 中 api/static 的成对 tag 后
docker compose -p recipesage pull api static
docker compose -p recipesage up -d

# 停止整栈（数据卷保留）
docker compose -p recipesage down