ghcr.io/kiwix/kiwix-serve:latest

Kiwix工具

Kiwix工具是一系列与Kiwix相关的命令行工具集合：

• kiwix-manage：管理基于XML的ZIM文件库
• kiwix-search：在ZIM文件中进行全文搜索
• kiwix-serve：提供ZIM文件服务的HTTP守护进程

免责声明

本文档假设您具备一定的软件编译知识。如果您在依赖项或Kiwix工具本身的编译过程中遇到困难，建议参考https://github.com/kiwix/kiwix-build%E3%80%82

前言

尽管Kiwix工具可以在/为多种系统编译/交叉编译，但以下文档将说明如何在POSIX系统上进行编译。本文档主要针对GNU/Linux系统，并已在https://debian.org/https://ubuntu.com%E5%92%8CFedora%E7%9A%84%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC%E4%B8%8A%E8%BF%9B%E8%A1%8C%E4%BA%86%E6%B5%8B%E8%AF%95%E3%80%82

依赖项

Kiwix工具依赖于一些第三方软件库。这些是Kiwix工具编译的先决条件。因此，需要确保以下库可用：

• https://github.com/kiwix/libkiwix%EF%BC%88Debian/Ubuntu%E4%B8%8A%E7%9A%84%E5%8C%85%E5%90%8D%E4%B8%BA%60libkiwix%60%EF%BC%89
• https://github.com/openzim/libzim%EF%BC%88Debian/Ubuntu%E4%B8%8A%E7%9A%84%E5%8C%85%E5%90%8D%E4%B8%BA%60libzim%60%EF%BC%89

这些依赖项可能已被您的操作系统打包，也可能未打包。它们也可能已打包但版本较旧，或者已打包但未提供静态版本。编译脚本会提示是否有依赖项缺失或版本过旧。最坏情况下，您需要手动下载并编译最新版本。

如果您希望在本地安装这些依赖项，请使用kiwix-tools目录作为安装前缀。

如果您希望静态编译Kiwix工具，依赖项也应静态编译（提供lib...a库），例如在./configure时使用--enable-static选项。

环境

Kiwix工具使用Meson 0.43或更高版本构建。Meson本身依赖Ninja、pkg-config和其他一些编译工具。请先安装这些工具：

• Meson
• Ninja
• https://www.freedesktop.org/wiki/Software/pkg-config/

如果您使用的是较新的操作系统，这些工具应该已经打包。如果没有，请查看故障排除部分。

编译

安装所有依赖项后，可以使用以下命令编译Kiwix工具：

meson . build
ninja -C build

默认情况下，将编译动态链接库。如果需要静态链接库，可以在Meson命令中添加-Dstatic-linkage=true选项。

根据您的系统，ninja可能被称为ninja-build。

安装

如果您希望安装Kiwix工具，请执行以下命令：

ninja -C build install

根据您的安装位置，可能需要以root用户身份（或使用sudo）运行该命令。安装成功后，可能需要（以root用户身份）运行ldconfig。

卸载

如果您希望卸载Kiwix工具，请执行以下命令：

ninja -C build uninstall

与安装类似，可能需要以root用户身份（或使用sudo）运行该命令。

Docker

Kiwix工具的官方Docker镜像可在https://ghcr.io/kiwix/kiwix-tools%E4%B8%8A%E6%89%BE%E5%88%B0%E3%80%82%E4%B9%9F%E6%9C%89%E4%B8%80%E4%B8%AA%E4%B8%93%E9%97%A8%E7%9A%84%60kiwix-serve%60 Docker镜像https://ghcr.io/kiwix/kiwix-serve%E3%80%82

故障排除

如果需要“手动”安装Meson：

virtualenv -p python3 ./ # 创建虚拟环境
source bin/activate # 激活虚拟环境
pip3 install meson # 安装Meson
hash -r # 刷新bash路径

如果需要“手动”安装Ninja：

git clone git://github.com/ninja-build/ninja.git
cd ninja
git checkout release
./configure.py --bootstrap
mkdir ../bin
cp ninja ../bin
cd ..

如果编译仍然失败，您可能需要获取比Linux发行版打包版本更新的依赖项。此时，请尝试使用问题上游项目分发的源代码 tarball，甚至直接从源代码仓库获取。

许可证

https://www.gnu.org/licenses/gpl-3.0%E6%88%96%E6%9B%B4%E9%AB%98%E7%89%88%E6%9C%AC%EF%BC%8C%E8%AF%A6%E8%A7%81COPYING%E3%80%82