openzim / openzim/overview

Define a strategy for storage of "user data" in readers

Open
#49 0 comments 0 reactions 3 assignees View on GitHub

@rgaudin is already working on this.

Since Mar 11, 2025.

enhancement
Dominant language
HTML
Stars
9
Forks
2
PR merge metrics
No merged PRs in 30d

Description

https://github.com/openzim/freecodecamp/issues/40 and https://github.com/openzim/freecodecamp/issues/92 require access to "some storage" in the ZIM reader to store data about user progress.

We need to first prototype and define a reference strategy so that what is done inside the ZIM integrates well:

  • good support in all (most?) kiwix readers with a stable JS API
  • persistent and "unlimited" storage volume:
    • no ephemeral data since it cannot be rebuild
    • no too hard limits on storage volume, even if some MB is probably sufficient in most cases, but could be somewhere in the tens of MBs)
  • strategy to make it available across ZIM updates (ZIM ID will change but same data must be retrieved) and potentially across multiple ZIMs (multiple ZIM might share some user data, e.g. preferred language, but also progress on a freecodecamp course which is present in multiple ZIMs)
  • strategy to support multiple users on the same reader (we know that users tend to share their device, e.g. in schools)
    • who is responsible to set current user profile ? Is it done at reader level ?
    • how the ZIM code has access to the information, uses this information to store user data

Some of this work has already been done in the scope of Nautilus but we need to make a reference document and implementation out of it, probably with a roadmap (e.g. we can start without the user profiles in a first iteration).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.