easysoft/zincsearch

QuickOn ZincSearch 应用镜像

https://github.com/quicklyon/zincsearch-docker/actions/workflows/docker.yml/badge.svg](https://github.com/quicklyon/zincsearch/actions/workflows/docker.yml) !Docker Pulls !Docker Image Size !GitHub tag

申明: 该软件镜像是由QuickOn打包。在发行中提及的各自商标由各自的公司或个人所有，使用它们并不意味着任何从属关系。

快速参考

• 通过 渠成软件百宝箱 一键安装 ZincSearch
• https://github.com/quicklyon/zincsearch-docker
• https://github.com/zinclabs/zinc
• ZincSearch 官网

一、关于 ZincSearch

Zinc 是一款支持全文索引的搜索引擎，是 Elasticsearch 的轻量级替代品，仅需很少资源即可运行，使用 bluge 作为底层索引库。它操作简单，Elasticsearch 需要几十个概念与配置来理解和调整，而 Zinc 可在 2 分钟内启动并使用。若仅通过 API 获取数据并进行搜索，它是 Elasticsearch 的直接替代品（Zinc 不支持 Kibana，提供自有 UI）。

!https://raw.githubusercontent.com/quicklyon/zincsearch-docker/master/.template/screenshot.jpeg

ZincSearch官网：[***]

1.1 为什么使用Zinc

Elasticsearch 虽为优秀产品，但复杂、资源需求大且已有十多年历史。Zinc 的构建旨在让人们更轻松地使用全文搜索索引，无需大量工作。

1.2 特性

• 提供全文索引功能
• 独立二进制文件，支持多平台安装和运行
• 基于 Vue 编写的 Web UI，用于数据查询
• 与 Elasticsearch API 兼容（单记录和批量 API）
• 开箱即用的身份验证
• 无模式（Schema less）- 无需预先定义模式，同一索引中的不同文档可具有不同字段
• 支持磁盘（默认）、s3 或 minio（实验性）存储索引
• 支持聚合功能

二、支持的版本(Tag)

由于版本较多，此处仅列出最新的5个版本，更详细版本列表请参考：https://hub.docker.com/r/easysoft/zincsearch/tags/

• https://github.com/zinclabs/zinc/releases
• https://github.com/zinclabs/zinc/releases/tag/v0.4.7
• https://github.com/zinclabs/zinc/releases/tag/v0.3.6
• https://github.com/zinclabs/zinc/releases/tag/v0.3.4
• https://github.com/zinclabs/zinc/releases/tag/v0.3.3
• https://github.com/zinclabs/zinc/releases/tag/v0.3.2
• https://github.com/zinclabs/zinc/releases/tag/v0.3.1
• https://github.com/zinclabs/zinc/releases/tag/v0.3.0
• https://github.com/zinclabs/zinc/releases/tag/v0.2.9

三、获取镜像

推荐从 https://hub.docker.com/r/easysoft/zincsearch 拉取官方Docker镜像。

bash
docker pull easysoft/zincsearch:latest

如需使用指定版本，可拉取含版本标签的镜像，在Docker Hub仓库中查看 https://hub.docker.com/r/easysoft/zincsearch/tags/

bash
docker pull easysoft/zincsearch:[TAG]

四、持久化数据

删除容器会导致所有数据丢失，为避免数据丢失，应挂载卷以持久化存储数据。需挂载的持久化目录：

• /data：用于存储持久化数据

若挂载目录为空，首次启动会自动初始化相关文件。

bash
$ docker run -it \
    -v $PWD/data:/data \
    easysoft/zincsearch:latest

或修改 docker-compose.yml 文件添加持久化目录配置：

yaml
services:
  ZincSearch:
    ...
    volumes:
      - /path/to/persistence:/data
    ...

五、环境变量

六、运行

6.1 单机Docker-compose方式运行

bash
# 启动服务
make run

# 查看服务状态
make ps

# 查看服务日志
docker-compose logs -f zincsearch

说明:

• 启动成功后，打开浏览器输入 http://<你的IP>:8080 访问管理后台
• 默认用户名：admin，默认密码：pass4Zinc
• https://github.com/quicklyon/zincsearch-docker/blob/master/VERSION 文件中详细定义了Makefile可操作的版本
• https://github.com/quicklyon/zincsearch-docker/blob/master/docker-compose.yml

6.2 本地测试

添加一条记录：

bash
curl \
  -u admin:pass4Zinc \
  -XPUT \
  -d '{"QuickOn":"渠成软件百宝箱"}' \
  http://localhost:8080/api/myfirstindex/_doc

打开浏览器，通过UI页面查看创建的记录是否存在。

七、版本升级

容器镜像已针对版本升级做特殊处理，当检测数据（数据库/持久化文件）版本与镜像内程序版本不一致时，会检查数据库结构并自动升级。因此，升级版本只需更换镜像版本号：

修改 docker-compose.yml 文件

diff
...
  zincsearch:
-    image: easysoft/zincsearch:0.2.8-20220701
+    image: easysoft/zincsearch:0.2.9-20220822
    container_name: zincsearch
...

更新服务：

bash
# 使用新版本镜像更新服务
docker-compose up -d

# 查看服务状态和镜像版本
docker-compose ps