spotx/konga

Konga Docker镜像文档

镜像概述和主要用途

Konga是一个非官方的Kong管理UI，并非Mashape官方应用。它提供可视化界面用于管理Kong API网关，支持Kong 0.11.x、0.12.x版本（旧版本可能兼容但不支持）。通过Konga可便捷管理Kong Admin API对象、多Kong节点、执行快照备份与恢复、监控节点和API状态等操作。

核心功能和特性

• 全面管理Kong对象：支持管理所有Kong Admin API对象
• 消费者导入：可从远程源（数据库、文件、API等）导入消费者
• 多节点管理：支持管理多个Kong节点
• 快照功能：对Kong节点进行备份、恢复和迁移
• 健康监控：通过健康检查监控节点和API状态
• 邮件通知：支持邮件通知功能
• 多用户支持：允许多用户使用
• 多数据库集成：支持MySQL、PostgreSQL、MongoDB、SQL Server等数据库

兼容性

Konga完全兼容Kong 0.11.x、0.12.x版本，旧版本可能工作但不受官方支持。

先决条件

• 运行中的Kong实例（参考Kong安装文档）
• Node.js环境（非Docker部署时需要）
• npm包管理器（非Docker部署时需要）

使用方法和配置说明

Docker镜像拉取

bash
docker pull pantsel/konga

基础运行（默认配置）

bash
docker run -p 1337:1337 \
           --link kong:kong \
           --name konga \
           -e "NODE_ENV=production" \  # 可选"development"，默认"development"
           pantsel/konga

数据库集成配置

Konga默认使用本地持久化存储（仅推荐非生产环境），也支持主流数据库。通过以下环境变量配置：

注意：使用MySQL、PostgreSQL或SQL Server时，首次需以开发模式启动以创建数据库表结构：

1. 进入容器：docker exec -it konga bash
2. 开发模式启动：node app.js --dev
3. 完成后重启容器并以生产模式运行

数据库集成示例（PostgreSQL）

bash
docker run -p 1337:1337 \
           --link kong:kong \
           --link postgres:postgres \  # 链接到PostgreSQL容器
           -e "DB_ADAPTER=postgres" \
           -e "DB_HOST=postgres" \
           -e "DB_PORT=5432" \
           -e "DB_USER=postgres" \
           -e "DB_PASSWORD=postgres" \
           -e "DB_DATABASE=konga_db" \
           -e "NODE_ENV=production" \
           --name konga \
           pantsel/konga

访问与登录

启动后，Konga UI可通过 http://{服务器IP}:1337 访问。默认用户：

• 管理员：登录名 admin，密码 adminadminadmin
• 演示用户：登录名 demo，密码 demodemodemo

首次登录后，需在设置中添加Kong节点，Admin URL填写 http://kong:8001（若使用--link链接Kong容器）。

升级

新版本Konga可能引入数据库结构变更，需先以开发模式启动一次以应用迁移：

1. 开发模式启动：node app.js --dev
2. 完成后重启并以生产模式运行

常见问题（FAQ）

1. 空白页与"Uncaught ReferenceError: angular is not defined"
   可能bower依赖未正确安装，进入容器执行：npm run bower-deps

2. 无法添加/编辑插件属性
   数组类型属性需在输入每个值后按Enter键确认（参考#48 issue）

3. 数据库迁移未自动运行
   需手动以开发模式启动触发迁移（参考#40 issue）

4. EACCES权限错误（mkdir '/kongadata/'）
   通过环境变量 STORAGE_PATH 指定有写权限的目录

许可证

MIT许可证，详见https://github.com/pantsel/konga/blob/master/LICENSE