ckman 安装和配置指南

ckman 安装和配置指南

ckman This is a tool which used to manage and monitor ClickHouse database 项目地址: https://gitcode.com/gh_mirrors/ck/ckman

1. 项目基础介绍和主要编程语言

项目基础介绍

ckman 是一个用于管理和监控 ClickHouse 数据库的工具。它通过前端界面访问集群的相关信息，可以轻松地部署、升级以及向集群中添加节点。ckman 由 EOI Technology Co., Ltd. 的工程数据库研发团队主导开发，并开源贡献给社区。

主要编程语言

ckman 的后端主要使用 Go 语言编写，前端使用 Vue 框架。

2. 项目使用的关键技术和框架

关键技术和框架

• 后端: Go 语言
• 前端: Vue 框架
• 数据库: ClickHouse
• 其他: Docker, Prometheus（用于监控）

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

1. 安装 Git: 用于克隆项目代码。
2. 安装 Go 语言环境: 用于编译和运行后端代码。
3. 安装 Node.js 和 Yarn: 用于编译前端代码。
4. 安装 Docker 和 Docker Compose: 用于容器化部署。

详细安装步骤

步骤 1: 克隆项目代码

首先，使用 Git 克隆 ckman 项目代码到本地：

git clone https://github.com/housepower/ckman.git
cd ckman

步骤 2: 编译前端代码（可选）

如果你需要自己编译前端代码，可以按照以下步骤操作：

cd frontend
yarn install
yarn build

编译完成后，前端代码会被打包到 static/dist 目录下。

步骤 3: 配置后端

在 config 目录下，编辑配置文件 config.yaml，根据你的环境配置相关参数，例如：

server:
  ip: 0.0.0.0
  port: 8808
  https: false
  certfile: conf/server.crt
  keyfile: conf/server.key
  pprof: true
  session_timeout: 3600
  public_key: conf/public.key
  swagger_enable: false
  task_interval: 5

步骤 4: 编译后端代码

使用 Go 语言编译后端代码：

go build -o ckman main.go

步骤 5: 运行 ckman

编译完成后，可以直接运行生成的可执行文件：

./ckman

步骤 6: 使用 Docker 部署（可选）

如果你希望使用 Docker 部署 ckman，可以使用以下命令：

docker-compose up -d

这将启动一个包含 ckman 的 Docker 容器，并自动配置运行环境。

总结

通过以上步骤，你可以成功安装和配置 ckman，开始管理和监控你的 ClickHouse 数据库集群。如果你在安装过程中遇到任何问题，可以参考项目的 GitHub 页面或联系开发者获取帮助。

ckman This is a tool which used to manage and monitor ClickHouse database 项目地址: https://gitcode.com/gh_mirrors/ck/ckman