GitHub - norish-recipes/norish: Norish - A realtime, self-hosted recipe app for families & friends · GitHub
Skip to content
norish-recipesPublic

About

Norish - A realtime, self-hosted recipe app for families & friends

Topics

Resources

Contributing

Stars

1.5k stars

Watchers

5 watching

Forks

Repository files navigation

WebsiteDocsLicense: AGPL-3.0Docker HubBuy me a coffeeNorish. Any source, any recipe. Import from recipe sites, YouTube, Instagram, photos and pasted text.Set it up using Docker Compose. Jump to the quick start.Scale any recipe: change the servings or switch between US and metric. Focus on cooking: timers, the ingredients each step needs, and the screen stays on.Plan the week in one shared meal calendar, do the groceries on a list synced in real time, and skip what is already in your pantry.Free and open source. Works offline, sign in with OIDC, GitHub, Google or email, and 17 languages.WebsiteDocsLicense: AGPL-3.0Docker HubBuy me a coffee

Quick start: save the file below as compose.yaml, set the two secrets and run docker compose up -d

Generate MASTER_KEY with openssl rand -base64 32 and keep it stable: it derives the encryption keys.

services:
  norish:
    image: norishapp/norish:latest
    container_name: norish-app
    restart: always
    ports:
      - "3000:3000"
    volumes:
      - norish_data:/app/uploads
    environment:
      AUTH_URL: http://localhost:3000
      DATABASE_URL: postgres://postgres:norish@db:5432/norish
      MASTER_KEY: <32-byte-base64-key> # openssl rand -base64 32
      OBSCURA_ENDPOINT: ws://obscura:9222
      OBSCURA_CDP_TOKEN: <random-token> # openssl rand -hex 32, same value on obscura
      VALKEY_URL: valkey://valkey:6379
      UPLOADS_DIR: /app/uploads
      
    healthcheck:
      test:
        [
          "CMD-SHELL",
          'node -e "require(''http'').get(''http://localhost:3000'' + (process.env.NEXT_PUBLIC_BASE_PATH || '''') + ''/api/v1/health/live'', r => process.exit(r.statusCode===200?0:1))"',
        ]
      interval: 1m
      timeout: 15s
      retries: 3
      start_period: 1m
    depends_on:
      - db
      - valkey

  db:
    image: postgres:17-alpine
    container_name: norish-db
    restart: unless-stopped
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: norish
      POSTGRES_DB: norish
    volumes:
      - db_data:/var/lib/postgresql/data

  # Renders recipe pages for URL imports
  obscura:
    image: norishapp/obscura:0.2.5-norish.1
    container_name: norish-obscura
    restart: unless-stopped
    environment:
      OBSCURA_CDP_TOKEN: <random-token>

  valkey:
    image: valkey/valkey:9
    container_name: norish-valkey
    restart: unless-stopped
    volumes:
      - valkey_data:/data

volumes:
  db_data:
  norish_data:
  valkey_data:

Reverse proxy, sign-in providers and AI are in the docs. Setup guide.

Contributions welcome. If you don't have any programming skills, making issues is appreciated and helps make Norish a better app. Norish is free software under AGPL-3.0. Last but not least, our dog Nora.Contributing guideDevelopment setup

About

Norish - A realtime, self-hosted recipe app for families & friends

Topics

Resources

Contributing

Stars

1.5k stars

Watchers

5 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages