Added Kiwix Serve to BigBearCasaOS

About

Kiwix Server is a .zim compatible web server: it allows you to deliver .zim files over the HTTP protocol within your local network – be it a University or your own house. Simply start Kiwix-Serve on your machine, and your content will be available for anybody through their web browser. This allows you to view a website without having internet access.

App Store

Features

  • Full text search engine
  • Search suggestions
  • Really small and efficient
  • Compatible with almost all browsers
  • Available on all platforms
  • Available as command line executable
  • Embedded in Kiwix UI
  • Able to deal with one ZIM file or XML library files
  • RESTful API endpoint with OPDS (XML)

What are ZIM files?

The ZIM file format is an open file format that stores wiki content for offline usage. The format is defined by the openZIM project, which also supports an Kiwix. The format is primarily used to store the contents of Wikipedia and other Wikimedia projects, including articles, full-text search indices and auxiliary files.

Documentation

Ensure that your there are .zim files in the /DATA/AppData/big-bear-kiwix-serve/zim directory otherwise the server won’t launch properly and will need to be restarted

For doumentation see the Kiwix wiki

Download ZIM files from the Kiwix library or create your own (see Zimit)

Script

can anyone get this to work?? it keeps defaulting to an address of 172.20.0.2:8080 even after i changed the ip address and port in the casa os settings and in the terminal for kiwix yet it keeps using that address that never loads.

I manually added it as a customized app using the following settings:

  • Docker Image: “ghcr.io/kiwix/kiwix-serve:latest” (remove quotation marks)

  • Port: Host 8080 → Container 8080 TCP

  • Volumes: where your zims are located → /data

  • Container Command (single entry): /data/*.zim

  • Restart Policy: unless-stopped

Hi all.

It works with latest tag and also with 3.7.0-2. Log tells:

/usr/local/bin/kiwix-serve --port=8080 *.zim
Unable to add the ZIM file '*.zim' to the internal library.
Here is the content of /data:

So, just add at least one zim file to folder. Default path is:

/DATA/AppData/big-bear-kiwix-serve/zim

Hi.

This IP:port is docker internal, You cannot access this port from Host, until You have setup network connection between Host and docker container as Bridge. This is how docker works (isolation).

Setup Bridge is not necessary for working! Just follow my post about 2 minutes ago in this thread.