Maintain Zimfarm recipes

This document describes the procedure to automatically create / adjust / delete recipes. It is intended for Kiwix recipes maitainers.

When not fully automated, maintenance is mostly based on recipesauto tool from https://github.com/openzim/zimfarm/tree/main/recipesauto which is meant to be ran on maintainer machine.

TED

# set context / secrets
 export TED_OPTIM_URL="https://s3.us-west-1.wasabisys.com/?keyId=xxx&secretAccessKey=xxx&bucketName=org-kiwix-ted"
export ZIMFARM_USER="xxxx"
 export ZIMFARM_PASSWORD="xxxx"

# dry-run
recipesauto --zimfarm-username $ZIMFARM_USER --zimfarm-password $ZIMFARM_PASSWORD --values ted_optim_url=$TED_OPTIM_URL ted

# apply
recipesauto --zimfarm-username $ZIMFARM_USER --zimfarm-password $ZIMFARM_PASSWORD --values ted_optim_url=$TED_OPTIM_URL ted -p

Some notes:

• this will update all recipes except ted_topic_all
• topics with less than 5 videos are automatically ignored
• you MUST still update the list of topics in https://farm.openzim.org/recipes/ted_topic_all everytime a new topic is added

Devdocs

# set context / secrets
export ZIMFARM_USER="xxxx"
 export ZIMFARM_PASSWORD="xxxx"

# dry-run
recipesauto --zimfarm-username $ZIMFARM_USER --zimfarm-password $ZIMFARM_PASSWORD devdocs

# apply
recipesauto --zimfarm-username $ZIMFARM_USER --zimfarm-password $ZIMFARM_PASSWORD devdocs -p

Freecodecamp

# set context / secrets
export ZIMFARM_USER="xxxx"
 export ZIMFARM_PASSWORD="xxxx"

# dry-run
recipesauto --zimfarm-username $ZIMFARM_USER --zimfarm-password $ZIMFARM_PASSWORD freecodecamp

# apply
recipesauto --zimfarm-username $ZIMFARM_USER --zimfarm-password $ZIMFARM_PASSWORD freecodecamp -p