kiwix
/
kiwix-tools
mirror of https://github.com/kiwix/kiwix-tools.git
1
0
Fork 1
Code Issues Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
kiwix-tools/docker
History
Emmanuel Engelhart 3c6971fced
Dedicated Docker Compose section 		2 years ago
..
server Dedicated Docker Compose section 2 years ago
Dockerfile Docker images for new architectures 2 years ago
README.md
…

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.