abesesr/swish-e-docker

swish-e-docker

镜像概述和主要用途

swish-e-docker旨在将swish-e搜索引擎打包到Docker容器中，提供CGI（Web表单）和命令行索引两种使用方式。由于swish-e是一款不再维护的旧软件，现代Linux操作系统（如RHEL 7.7）已不再分发该软件。通过Docker容器化，可以在现代操作系统中隔离运行swish-e，避免对系统造成干扰，同时继续使用其搜索功能。

核心功能和特性

• 支持swish-e CGI模式，提供Web搜索表单界面
• 支持命令行索引功能，可对文档进行索引操作
• 允许通过挂载配置文件自定义搜索和索引行为
• 兼容HTML、DOC、PDF等多种文档类型的索引

使用场景和适用范围

适用于需要在现代操作系统中继续使用swish-e搜索引擎的场景，尤其适合需要对本地文档（如技术手册、指南）提供搜索功能的应用，例如内部文档检索系统。

使用方法和配置说明

运行Web服务器（CGI模式）

启动包含swish-e CGI的Web服务器，提供Web搜索表单：

bash
# 调整8080端口为所需的监听端口
docker run -d --name gm-swish \
  -p 8080:80 \
  -v /var/apache2/htdocs/guide/html/.swishcgi.conf:/usr/lib/cgi-bin/.swishcgi.conf \
  abesesr/swish-e-docker:1.1.1

启动后，可通过以下地址访问搜索表单：[***]

索引数据

对容器内/var/www/html/目录下的HTML数据进行（重新）索引（需通过swish.conf中的"IndexDir"指令指向该目录）：

bash
docker run --rm -it \
  -v /var/apache2/htdocs/guide/html/:/var/www/html/ \
  -v /var/apache2/htdocs/guide/html/swishPourManuels.conf:/usr/lib/cgi-bin/swish.conf \
  abesesr/swish-e-docker:1.1.1 \
  swish-e -c swish.conf

配置说明

CGI配置文件

可通过以下文件配置swish-e CGI：

• .swishcgi.conf：最常用的配置文件，用于配置集成到Web服务器的swish-e CGI
• swish.cgi：CGI程序本身
• TemplateDefault.pm：模板文件

可通过挂载本地自定义文件进行配置，示例：

bash
# 调整8080端口为所需的监听端口
docker run -d --name gm-swish \
  -p 8080:80 \
  -v /var/apache2/htdocs/guide/html/.swishcgi.conf:/usr/lib/cgi-bin/.swishcgi.conf \
  -v /opt/abes-swish-e-docker/swish.cgi:/usr/lib/cgi-bin/swish.cgi \
  -v /opt/abes-swish-e-docker/TemplateDefault.pm:/usr/lib/swish-e/perl/SWISH/TemplateDefault.pm \
  abesesr/swish-e-docker:1.0.0

索引配置文件

通过swish.conf配置swish-e索引脚本，该文件用于指定索引位置（告知swish-e在哪里查找.html、.doc、.pdf等文件进行索引）。

开发指南

构建镜像

首次开发或修改Dockerfile后，需构建镜像：

bash
cd image/
docker build -t mylocalswish-e:latest .

创建容器

创建用于CGI调试或索引的容器：

bash
# CGI调试容器（访问http://127.0.0.1:8080/cgi-bin/swish.cgi）
docker run --name swish-debug -d -p 8080:80 mylocalswish-e:latest

# 在上述CGI容器内执行索引
docker exec -it swish-debug swish-e -c swish.conf

生成新版本

生成新版本时，执行以下命令（根据需要修改NEXT_VERSION行中的"-patch"选项）：

bash
curl https://raw.githubusercontent.com/fmahnke/shell-semver/master/increment_version.sh > increment_version.sh
chmod +x ./increment_version.sh
CURRENT_VERSION=$(git tag | tail -1)
NEXT_VERSION=$(./increment_version.sh -patch $CURRENT_VERSION) # -patch（补丁版本）、-minor（次要版本）或 -major（主要版本）
sed -i "s#swish-e-docker:$CURRENT_VERSION#swish-e-docker:$NEXT_VERSION#g" README.md
git commit README.md -m "Version $NEXT_VERSION" 
git tag $NEXT_VERSION
git push && git push --tags

相关链接

• Debian软件包：swish-e
• swish.cgi手册页