eeacms/esbootstrap

EEA Node.js Elasticsearch应用引导程序

镜像概述和主要用途

这是一个简单的演示应用，可作为新Node.js Elasticsearch应用的基础框架。它提供基本的索引命令、列表页、详情页以及CSV/TSV导出功能，通过克隆和最小化配置即可快速创建新的搜索应用。

核心功能和特性

• 提供基础索引操作命令，支持数据索引管理
• 包含列表页与详情页，用于展示索引数据
• 支持CSV/TSV格式数据导出
• 易于克隆和配置，可快速扩展为定制化搜索应用

使用场景和适用范围

适用于需要快速开发基于Elasticsearch的搜索应用场景，帮助开发人员减少初始配置工作，快速搭建应用基础框架。

使用方法和配置说明

独立使用（Standalone）

基本使用命令如下：

bash
docker run -d -v /path/of/your/config/:/code/config:z -p 8080:3000 -e "elastic_host=<elasticsearch_host_or_ip>" eeacms/esbootstrap:Według

参数说明：

• <elasticsearch_host_or_ip>：Elasticsearch服务器的URL或IP（不带端口）
• /path/of/your/config/：包含应用配置文件的本地文件夹，配置方法参见配置说明

使用Rancher

设置方法参见https://github.com/eea/eea.rancher.catalog/blob/master/templates/elastic-app-esbootstrap/0/README.md%E3%80%82

使用eea.docker.searchservices

创建新应用需遵循以下步骤：

1. 在开发机上克隆eea.docker.searchservices

bash
$ git clone --recursive https://github.com/eea/eea.docker.searchservices.git

2. 克隆eea.docker.esbootstrap

bash
$ cd eea.docker.searchservices
$ # 克隆eea.docker.esbootstrap并命名为eea.docker.newesapp
$ git clone https://github.com/eea/eea.docker.esbootstrap.git eea.docker.newesapp

3. 配置新应用

config文件夹包含应用的配置文件，配置方法参见配置说明。

4. 配置eea.docker.searchservices以包含新应用

4.1. 在docker-compose.dev.yml文件中添加配置

克隆docker-compose.dev.yml.example文件并命名为docker-compose.dev.yml，添加开发环境设置：

yaml
newesapp:
  image: eeacms/esbootstrap:dev # 使用开发构建版本
  links:
      - esclient
  ports:
      - 3030:3000 # 使用空闲端口
  environment:
      - elastic_host=esclient
      - AUTO_INDEXING=true # 首次启动时自动索引数据
      # - SYNC_CRONTAB=*/30 * * * * # 可选，每30分钟执行一次同步的定时任务
      # - GOOGLE_MAP_KEY=google-map-api-key # 启用地理facet中的谷歌地图扩展功能需配置有效API密钥（从https://developers.google.com/maps/documentation/javascript/get-api-key获取）
  volumes:
      - ./eea.docker.newesapp/app/:/code/:z # 挂载代码卷以方便开发
      - ./eea.searchserver.js/lib/:/node_modules/eea-searchserver/lib/:z

4.2. 测试应用

在eea.docker.searchservices目录下：

首次使用需构建所有应用的开发镜像：

bash
./build_dev.sh -s

后续修改应用后，仅需重建该应用（非必须，因已挂载代码卷，但若需构建镜像可执行）：

bash
./build_dev.sh newesapp -s

4.3. 启动整个栈

在eea.docker.searchservices目录下启动整个服务栈：

bash
docker-compose -f docker-compose.dev.yml up

4.4. 在浏览器中测试

在浏览器中访问：

http://<机器IP>:<端口>

5. 添加到生产栈

应用完成首个可用版本后，应：

• 将其作为git子模块添加到eea.docker.searchservices
• 为eea.docker.newesapp创建git标签
• 在https://hub.docker.com%E6%B7%BB%E5%8A%A0%E5%BA%94%E7%94%A8%E5%B9%B6%E5%90%AF%E7%94%A8%E6%A0%87%E7%AD%BE%E8%87%AA%E5%8A%A8%E6%9E%84%E5%BB%BA
• 在eea.docker.searchservices的docker-compose.yml中添加应用并固定到创建的标签

详细说明

有关实现细节，请阅读文档。