Git Product home page Git Product logo

zimfarm's Introduction

ZIM Farm

Build Status CodeFactor License: GPL v3 codecov

The ZIM farm (zimfarm) is a half-decentralised software solution to build ZIM files efficiently. This means scrapping Web contents, packaging them into a ZIM file and uploading the result to an online ZIM files repository.

Principle

The whole zimfarm system works as a task scheduler and is made of two components:

  • The dispatcher, the central node, which takes and dispatches zim file generation tasks. It is managed by the openZIM project admin and hosted somewhere on the Internet.

  • The workers, task executers, which are hosted by openZIM volunteers in different places around the world through Internet.

To get a new ZIM file the typical workflow is:

  1. User submits a new task (to get a specific ZIM file made).
  2. Dispatcher enqueues the task.
  3. A worker pulls the task.
  4. Worker generates the ZIM file and upload it.

Refer to workers to run a worker.

Architecture

The whole system is built by reusing the best of free software libraries components. The whole ZIM farm solution itself is made available using Docker images.

Actually, we use even more Docker images, as the ZIM file are produced in dedicated custom Docker images the worker has to "invoke" depending of the properties of the task he has to accomplish.

zimfarm's People

Contributors

automactic avatar rgaudin avatar kelson42 avatar jenskorte avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.