从安装到部署：Mirage本地环境搭建完全指南

【免费下载链接】mirage :art: GUI for simplifying Elasticsearch Query DSL 项目地址: https://gitcode.com/gh_mirrors/mir/mirage

Mirage是一款功能强大的Elasticsearch查询DSL图形化工具，通过直观的界面帮助用户轻松构建复杂的Elasticsearch查询。本指南将带你完成从环境准备到本地部署的完整流程，让你快速体验这款高效的查询构建工具。

环境准备：搭建基础开发环境

在开始安装Mirage之前，确保你的系统已安装以下必要工具：

• Node.js (推荐v10及以上版本)
• npm (通常随Node.js一起安装)
• Git (用于克隆代码仓库)
• Docker (可选，用于容器化部署)

如果你使用的是Linux系统，可以通过系统包管理器安装这些依赖；Windows和macOS用户可以从官方网站下载对应安装程序。

快速开始：三种安装方式任选

方式一：源码编译安装（推荐开发者）

1. 克隆代码仓库

   git clone https://gitcode.com/gh_mirrors/mir/mirage
   cd mirage
   

2. 安装依赖包

   npm install
   bower install
   

3. 启动本地开发服务器

   npm start
   

   服务启动后，访问 http://localhost:3030 即可使用Mirage。

方式二：Docker容器化部署（推荐生产环境）

1. 拉取Docker镜像

   docker pull appbaseio/mirage
   

2. 运行容器

   docker run -p 3030:3030 -d appbaseio/mirage
   

   容器启动后，同样通过 http://localhost:3030 访问应用。

方式三：Elasticsearch插件安装（仅支持ES 1.x/2.x）

⚠️ 注意：该方式已 deprecated，官方推荐使用Docker部署

plugin install appbaseio/mirage

安装完成后通过 http://127.0.0.1:9200/_plugin/mirage 访问。

配置Elasticsearch：解决跨域问题

为确保Mirage能正常连接Elasticsearch，需要在ES配置文件中添加CORS设置：

http.port: 9200
http.cors.allow-origin: "/.*/"
http.cors.enabled: true
http.cors.allow-headers: X-Requested-With,X-Auth-Token,Content-Type, Content-Length, Authorization
http.cors.allow-credentials: true

修改完成后重启Elasticsearch服务使配置生效。

验证安装：测试Mirage功能

1. 打开浏览器访问 http://localhost:3030
2. 在连接设置中输入Elasticsearch地址
3. 尝试创建一个简单的匹配查询
4. 查看生成的JSON查询语句并执行
5. 验证结果是否正确返回

如果一切正常，你现在已经成功搭建了Mirage本地环境！

常见问题解决

端口冲突怎么办？

如果3030端口已被占用，可以修改启动命令指定其他端口：

npm start -- --port 8080

依赖安装失败？

尝试清除npm缓存后重新安装：

npm cache clean --force
npm install

Docker方式启动后无法访问？

检查容器是否正常运行：

docker ps

如果容器未运行，可以查看日志排查问题：

docker logs [容器ID]

项目结构概览

Mirage的主要代码结构如下：

• app/: 包含应用核心组件和功能模块
  • features/: 各种功能组件
  • queryBlocks/: 查询构建相关组件
  • shared/: 共享服务和工具
• assets/: 静态资源文件
• package.json: 项目依赖配置
• Dockerfile: 容器化配置文件

通过本指南，你已经掌握了Mirage的本地环境搭建方法。现在可以开始探索这款强大的Elasticsearch查询工具，简化你的查询构建流程！

【免费下载链接】mirage :art: GUI for simplifying Elasticsearch Query DSL 项目地址: https://gitcode.com/gh_mirrors/mir/mirage