Skip to content

Create a new worker

benoit74 edited this page Oct 17, 2025 · 4 revisions

We invite people to donate workers so we can process more tasks. When someone volunteers to, here's what Zimfarm Admins have to do:

  • Ensure they've read and understood the doc
  • Ensure they have a static public IP. ZF is able to work with IPs that change but changes should not be frequent.
  • Explain how to configure the Offliner part of the config.
    • youtube is left out by default as it requires a static public IP. It should also be reserved to IPs not used for other YT requests (such as regular YT usage).
    • Should youtube be wanted, IP must be manually configured on all API Keys.
  • Create a dedicated user account with the worker role. Use contributor's given username or choose appropriately.
  • If contributor did not send a public ed25519 key
ssh-keygen -t ed25519 -f id_ed25519
  • Upload the public key inside the edit worker form or via API
  • Request a small task (wikipedia_fr_test for instance) on this worker.
  • Ask contributor to follow Setup and assist them until that task is complete, ZIM is uploaded and can be downloaded.
  • Inform about new work in #zimfarm on Slack.

Clone this wiki locally