Tandoor Recipes Documentation

This community-contributed setup uses Docker Compose, Traefik, and Apache to host Tandoor under a specific sub-path.

Key Configuration Requirements:

• Environment Variables: You must set SCRIPT_NAME, STATIC_URL, and MEDIA_URL in the recipes service to match your sub-path routing.
• Volumes: The apache service needs read-only access to the static and media directories, while the recipes service needs read-write access to them.
• Traefik Labels: Configure Traefik routers to use PathPrefix for both the Apache service and the Recipes service.
• Apache Configuration: Use Alias directives to map the static and media URLs to the correct local paths.

# recipes service environment
    environment:
      - SCRIPT_NAME=/<sub path>
      - STATIC_URL=/<www path>/static/
      - MEDIA_URL=/<www path>/media/

# apache configuration
  Alias /<www path>/static/ /var/www/recipes/static/
  Alias /<www path>/media/ /var/www/recipes/media/
  <Directory "/var/www/recipes/">
    Require all granted
  </Directory>

To build a complete recipe during import, you need to interact with several related models: Step, Ingredient, Food, Unit, and Keyword.

Keywords

Use Keyword.objects.get_or_create() to add keywords to the recipe. Always pass space=self.request.space to ensure the keyword belongs to the correct user space.

Steps and Ingredients

1. Create a Step: Use Step.objects.create(). You should provide instruction, order, and space. You can also set show_ingredients_table based on user preferences via self.request.user.userpreference.show_step_ingredients.
2. Create Ingredients: For each ingredient in a step, use Ingredient.objects.create(). This requires:
   • food: Use Food.objects.get_or_create(name=..., space=self.request.space)[0].
   • unit: Use Unit.objects.get_or_create(name=..., space=self.request.space)[0].
   • amount: The numeric quantity.
   • space: self.request.space.
3. Link to Recipe: Use recipe_object.steps.add(step) and recipe_object.keywords.add(keyword) to associate these objects with the main Recipe instance.

from cookbook.models import Recipe, Keyword, Step, Ingredient, Food, Unit

def get_recipe_from_file(self, file) -> Recipe:
    recipe_object = Recipe.objects.create(
        name = your_recipe_name,
        created_by = self.request.user,
        internal = True,
        space = self.request.space,
    )
    
    # Logic for creating keywords
    for keyword in parsed_file.keywords:
        recipe_object.keywords.add(
            Keyword.objects.get_or_create(
                space=self.request.space, 
                name=keyword)[0])
    
    i = 0
    for line in parsed_file:
        # Logic for creating steps
        step = Step.objects.create(
            instruction=line.instruction_string, 
            order=i, 
            space=self.request.space, 
            show_ingredients_table=self.request.user.userpreference.show_step_ingredients)
        
        # Logic for creating ingredients within the step
        for ingredient in line.ingredients:
            step.ingredients.add(
                Ingredient.objects.create(
                    food=Food.objects.get_or_create(name=ingredient.name, space=self.request.space)[0],
                    unit=Unit.objects.get_or_create(name=ingredient.quantity.unit, space=self.request.space)[0],
                    amount=ingredient.quantity.amount,
                    space=self.request.space, ))
        
        recipe_object.steps.add(step)
        i += 1
        
    recipe_object.save()
    return recipe_object