github-mirrors/kiwix-tools
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-tools.git synced 2025-06-27 17:00:36 -04:00
Code Issues Projects Releases Packages Wiki Activity
kiwix-tools/docker
History
Exact
Emmanuel Engelhart 3c6971fced
Dedicated Docker Compose section
2023-08-13 09:38:59 +02:00
..
server Dedicated Docker Compose section 2023-08-13 09:38:59 +02:00
Dockerfile Docker images for new architectures 2023-06-16 17:59:33 +02:00
README.md Add link to Kiwix server container image 2023-05-24 09:51:11 +02:00

README.md

Kiwix-tools Docker image

  • Available on ghcr.io.
  • multi-arch (linux/amd64, linux/arm64, linux/arm/v7)
  • based on official kiwix-tools binaries.

Usage

$ docker run -it ghcr.io/kiwix/kiwix-tools:3.1.2

Welcome to kiwix-tools! The following binaries are available:
kiwix-manage  kiwix-search  kiwix-serve

kiwix-tools operates on zim files. You shall mount a volume to access the files.

docker run -v $(pwd):/data -it ghcr.io/kiwix/kiwix-tools kiwix-search /data/wikipedia_fr_test.zim "Mali"

Building and reusing

  • kiwix/kiwix-tools is multi-arch and is ideally built using buildx.
  • requires a --build-arg VERSION= with the kiwix-tools release.
  • can be built using docker build in which case it expects an additionnal --build-arg ARCH=arm for arm. Otherwise defaults to amd64.

Notes:

  • wget in alpine:3 on arm/v7 (inside github action only) crashes when downloading from HTTPs locations. Keep http-only in Dockerfile.
  • Was also unhappy when using the mirrors so it's using mirror.download on purpose.

See also

If you are interested by a Kiwix server only container image, here it is.