Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 2.11 KB

README_zh-CN.md

File metadata and controls

96 lines (64 loc) · 2.11 KB
Raw

KoKo

简体中文 · English

Koko 是 JumpServer 连接字符协议的终端组件，支持 SSH、TELNET、MySQL、Redis 等协议。

Koko 使用 Golang 和 Vue 来实现，名字来自 Dota 英雄 Kunkka。

主要功能

  • SSH
  • SFTP
  • web terminal
  • web文件管理

安装

1.下载项目

git clone https://github.com/jumpserver/koko.git

2.编译应用

在 koko 项目下构建应用.

make

如果构建成功，会在项目下自动生成 build 文件夹，里面包含当前分支各种架构版本的压缩包。 默认构建的 VERSION 为 [branch name]-[commit]。 因为使用go mod进行依赖管理，可以设置环境变量 GOPROXY=https://goproxy.io 代理下载部分依赖包。

使用 (以 Linux amd64 服务器为例)

1.拷贝压缩包文件到对应的服务器

通过 make 构建默认的压缩包，文件名如下: 
koko-[branch name]-[commit]-linux-amd64.tar.gz

2.解压编译的压缩包

tar xzvf koko-[branch name]-[commit]-linux-amd64.tar.gz

3.创建配置文件config.yml，配置参数请参考config_example.yml文件

touch config.yml

4.运行koko

cd koko-[branch name]-[commit]-linux-amd64

./koko

开发环境

  1. 运行 server 后端
$ cp config_example.yml config.yml  # 1. 准备配置文件
$ vim config.yml  # 2. 修改配置文件, 编辑其中的地址 和 bootstrap key
CORE_HOST: http://127.0.0.1:8080
BOOTSTRAP_TOKEN: PleaseChangeMe<改成和core一样的>

$ go run cmd/koko/koko.go # 3. 运行, 运行需要 go 如果没有，golang.org 下载安装
  1. 运行 ui 前端
$ cd ui 
$ yarn install
$ npm run serve
  1. 测试 在 luna 访问 linux 资产，复制 iframe 地址，端口修改为 9530 即可，也可以修改 nginx 将 /koko 映射到这里

构建docker镜像

依赖 docker buildx 构建多平台镜像，需要安装 docker 19.03+ 版本，并开启 docker buildx 插件。

make docker

构建成功后，生成koko镜像