Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support OPDS #489

Open
kelson42 opened this issue Apr 25, 2019 · 6 comments
Open

Support OPDS #489

kelson42 opened this issue Apr 25, 2019 · 6 comments
Labels
Milestone

Comments

@kelson42
Copy link
Collaborator

OPDS is the new way to deliver the ZIM catalog. See https://wiki.kiwix.org/wiki/OPDS
Would that be possible to support OPDS in Kiwix JS?

@Jaifroid
Copy link
Member

@kelson42 Three questions about this (related to Kiwix JS Windows, which has an implementation of a download library):

  1. Are there plans to deprecate direct browsing of http://download.kiwix.org/zim/ for directories and filenames? I currently scrape those indices for filenames in Kiwix JS Windows. Not the right way, I know... NB I get the download links from the .meta4 file, so users of the app have a choice of mirrors.

  2. Currently I can get the torrent for a given ZIM by adding .torrent instead of .meta4 on the filename, and this works. Can I still rely on that?

  3. Have all "split" versions of ZIM files been deprecated (*.zimaa *.zimbb etc.)? There are now only quite old files in http://download.kiwix.org/zim/portable/. If so, I should remove my "portable" links.

I know the right way is to query the catalog, but it may take some time to develop...

@kelson42
Copy link
Collaborator Author

1. Are there plans to deprecate direct browsing of `http://download.kiwix.org/zim/` for directories and filenames? I currently scrape those indices for filenames in Kiwix JS Windows. Not the right way, I know... _NB I get the download links from the `.meta4` file, so users of the app have a choice of mirrors._

No

2. Currently I can get the torrent for a given ZIM by adding `.torrent` instead of `.meta4` on the filename, and this works. Can I still rely on that?

Yes

3. Have all "split" versions of ZIM files been deprecated (*.zimaa *.zimbb etc.)? There are now only quite old files in `http://download.kiwix.org/zim/portable/`. If so, I should remove my "portable" links.

Yes

@mossroy
Copy link
Contributor

mossroy commented Apr 28, 2019

Listing and downloading ZIM files from the app is currently not implemented in kiwix-js. We simply point to https://download.kiwix.org/zim/.
@Jaifroid has implemented some logic inside kiwix-js-windows (without OPDS)

@kelson42
Copy link
Collaborator Author

kelson42 commented Aug 22, 2021

The OPDS stream has been strongly developed and as soon as libkiwix10 is release (in a few days) should be considered ready to use. A pure OPDS reader is now available in kiwix serve welcome page.

@Jaifroid
Copy link
Member

@kelson42 Is the pure OPDS reader implemented in JS, do you know?

@kelson42
Copy link
Collaborator Author

@Jaifroid yes, you can try it by downloading a nightly build of kiwix-serve. The js code is in the libkiwix for the moment. I'm perfectly aware that such a piece of software/js library would benefit to many of our solutions and therefore if your are happy with it we could/should consider to isolate it to simplify maintenance/integration.

@Jaifroid Jaifroid added this to the v4.2 milestone Jun 16, 2023
@Jaifroid Jaifroid modified the milestones: v4.3, v4.4 Jul 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants