1 Star 0 Fork 2

tianyuliang / cloudcds-go-console

forked from cloudzone / cloudcds-go-console 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

##欢迎大家拓展此项目,增加更多的功能服务大家。

##常规编译

mkdir -p $GOPATH/src/git.oschina.net/cloudzone
git clone https://git.oschina.net/cloudzone/cloudcds-go-console.git
cd ./cloudcds-go-console
chmod +x build.sh
./build  # 构建部署包,构建成功后在当前bin目录产生 webconsole-1.0.0.tar.gz 

##常规部署

# 例如 部署到 /home/deploy/webconsole 目录
mkdir -p /home/deploy/webconsole
cp $GOPATH/src/git.oschina.net/cloudzone/cloudcds-go-console/bin/webconsole-1.0.0.tar.gz /home/deploy/
cd /home/deploy/

# 解压
tar -zxvf webconsole-1.0.0.tar.gz -C /home/deploy/webconsole

# 创建配置文件
cp ./webconsole/conf/conf.example.json ./webconsole/conf/conf.json   

# 配置环境变量
export CONSOLE_BIN_PATH=/home/deploy/webconsole/main    
export CONSOLE_PROJECT_DIR=/home/deploy/webconsole

# 启动进程
nohup ./webconsole/main -c start &     

##注意事项

1、如果端口号或IP,需要在conf.json的“cors_white_list”配置项增加白名单
2、启动main进程的服务器,需要先执行一次SSH登陆,避免出现“The authenticity of host '192.168.2.218 (192.168.2.218)' can't be established. ECDSA key fingerprint is af:7a:19:1d:76:b7:9b:51:0c:88:9a:4c:33:d0:f8:a5.”, 否则页面可能出现异常

##配置项说明

{
    "web": {
        "addr": ":8080",                    # http启动端口
        "tls_addr": ":8443",                # https启动端口
        "tls_url": "https://webconsole.realclouds.org",
        "static_dir": "/static",            # 静态资源目录
        "template_dir": "template/default", # html模板文件目录
        "template_suffix": ".html",         # 模板文件拓展名
        "session_timeout": 1800,            # session超时时间
        "enable_jsonp": false,
        "jsonp_param": "callback",
        "enable_gzip": false,
        "enable_tls": false,                # 访问页面的IP白名单
        "cors_white_list": "127.0.0.1,127.0.0.1:8081,127.0.0.1:8080,127.0.0.1:8443,localhost,localhost:8080,localhost:8081,localhost:8443",
        "enable_fcgi": false,
        "tls_cert": "214044428560678.pem",
        "tls_key": "214044428560678.key",
        "daemon": false
    },
    "cds": {
        "startCmd": "sh /home/cassandra/apache-cassandra-3.11.1/bin/cqlsh\n  clear \n", # SSH登陆后执行的shell脚本
        "exitCmd": "exit \n"                                                            # shell脚本退出后,额外执行的命令
    }
}

下载 Golang

##更新日志

2017.07.31

更新:

    1、更新 xTerm.js

2017.07.20

修证:

    1、修证UTF-8字符集展示BUG;
    2、修证大文件展示BUG。

    本次BUG由 @AEGQ 修证和贡献代码

2017.04.19

更新:
    1、删除 build.sh
    2、添加部署说明

2017.04.15

修证:
    1、修证一些页面的展示BUG。

更新:
    1、更新xTerm库。
    2、添加外部引用例子。

2017.04.11

更新:
    1、添加对 JSONP 的支持,解决 JQuery 跨域请求的需求。
    2、配置文件新增 JSONP 的支持。

感谢 @朱小四(weichat:juechengke) 提出需求。

2017.03.27

修证:
    1、修证粘贴字串的BUG。

更新:
    1、更新 xTerm 库。

2017.03.14

修证:

    1、修证 wss 协议适配 BUG

更新:
    1、删除根目录 golang 程序包。如果运行脚本,请自行下载对应 golang 包(go1.8.linux-amd64.tar.gz)放置根目录。

2017.02.27

修证:

    1、修改部分BUG
    2、更新 Golang 到 1.8 版本
    3、修证 Golang 1.8 版本中 url.Parse 解析地址 BUG
    4、替换 term.js 为 xterm.js
    5、更新对CJK(中文、日文、韩文)字符集和IME的支持
    6、更友好地支持 Linux 下主流程序,如:VIM、Tmux等

2016.05.25

修证:

    1、修证 log 目录不存在而引起的无法启动程序的 BUG
    2、Dockerfile 无法 Build 项目的 BUG 

2016.05.21

修证:

    1、SSH Session 退出异常 BUG

2016.05.17

新增:
    添加跨域白名单的支持。(conf/conf.json     cors_white_list:"127.0.0.1,www.xxx.com");

感谢 @玩蝴蝶的法师 提出的功能建议。

2016.05.13

修证:
    1、修证 Ubuntu 下无法使用 VIM 的 BUG;

替换:
    2、更换 Gorilla 的 Websocket 库。

感谢 @玩蝴蝶的法师 提出的建议和BUG。

2016.03.05

新增:
    1、增加 Dockerfile

2016.03.04 发布 v1.1

新增:
    1、增加命令行的启动、停止、状态查看功能. 如: ./apibox start/stop/status

2016.03.03

修证:
    1、修改独立模式时登陆JS验证问题.

新增:
    1、增加后台运行模式(conf/conf.json.  daemon:true/false);
    2、增加程序运行时的PID文件(log/apibox.pid);

##大概的数据流向:

    浏览器 --》 WebSocket --》SSH --》 Linux OS

###代码地址

Git@OSC

Github

演示地址

##程序包结构:

webconsole
├── conf
│   ├── conf.example.json
│   ├── conf.json       # 需自行创建
│   ├── ssl_cert.crt    # 默认不存在
│   ├── ssl_cert.key    # 默认不存在
│   └── mime.types
├── gitversion          # 最新commit值
├── log
│   └── 2018-01-29.log
├── main                # 可执行程序
├── static
│   ├── images
│   └── scripts
├── template
│   └── default
└── var
    └── console.pid     # 当前进程的PID

运行环境要求:

1、Linux Kernel 3.x/x86_64 及更高版本
2、建议 Linux 发行版 CentOS 7.0+ / Ubuntu 14.04+
3、启用支持 SSL/TLS 模式访问时,需要生成对应的 SSL 证书文件且放置到 "conf" 文件夹下并配置 "conf.json" 文件
4、客户端要求使用 IE9、Chrome 40、Firefox 38、Safari 9 或更高版本的浏览器访问
5、服务器端需要对防火墙开启对应的外部访问端口。具体需要开放的端口请参考 "conf" 文件夹下的 "conf.json" 文件中的端口部分的配置
6、本程序只能对 Unix/Linux 类的操作系统,且支持 SSH 协议的 OS 进行远程操作
7、基于Go1.6+,原生支持 http2 


一、部署
1、将程序解压或下载至任一目录,运行 "build.sh" 编译可执行文件
2、然后运行 "bin" 文件夹下的 "apibox" 文件即可。如:"./apibox start/stop"
3、配置文件在 "conf" 文件夹下,核心配置文件为 "conf.json",部署的时候需要添加跨域白名单来支持其他机器的访问
4、后台运行可以配置 "conf" 文件夹下的 "conf.json" 文件,将 "daemon" 项配置为 "true" 
5、运行时日志文件存放在 "log" 文件夹下,以当天时期命名
6、也可以配置程序以 Nginx 的 fcgi 模式运行,以 Nginx 做为访问入口

二、使用 1、程序部署完成后,直接通过浏览器访问即可。如: http(s)://ip:port。

2、外部系统引用步骤:

1)、以 GET 或 POST 的方式,提交 "vm_addr" 参数至 "http(s)://ip:port/console/chksshdaddr" ,成功后可获取到加密后的 "en_addr" 信息。注:vm_addr 格式为: "ip:port" ,若不携带端口,默认端口为 "22" 。

    获取到的结果为 JSON 格式(注:以下数据为测试数据):

        成功:
            {
                "ok": true,
                "msg": "",
                "data": { "en_addr": "0b-nDgcazQKTmUw4oBLfxott", "sshd_addr": "192.168.220.173:22" }
            }

        失败:
            { "ok": false, "msg": "Unable to resolve host address.", "data": null }

2)、成功获取到加密的 en_addr 信息后,以 GET 或 POST 方式访问  "http(s)://ip:port/console/login/'en_addr'" 即可。注: "en_addr" 是通过第 1)步操作获取的数据。

##JQuery Demo:

###第一种方式(需要二次登陆,同一个域的情况,同样可以使用跨域的方式访问):

var protocol = (location.protocol === "https:") ? "https://" : "http://";
var addr = protocol + location.hostname + ((location.port) ? (":" + location.port) : "")

$.post(addr+"/console/chksshdaddr?rnd=" + Math.random(), {
    "vm_addr": "192.168.220.177:22"
}, function(data) {
    var json = data;
    if (typeof(data) != "object") {
        json = $.parseJSON(data);
    }
    if (json.ok) {
        location.href = addr + json.data.sshd_addr;
    }
});

###第二种方式(直接输入远端的主机地址、用户名、密码,然后直接登陆。跨域的情况):

<button class="btn btn-primary" onclick="testDemo();">Test</button>

<script type="text/javascript">
    //注意,如果远程主机的访问地址是以IP形式出现的,可以忽略此步骤,直接调用 login 方法。具体登陆地址端口请根据实际情况更改.
    var testDemo = function() {
        $.ajax({
            url: "http://a.com:8081/console/chksshdaddr?rnd=" + Math.random(),
            method: "POST",
            data: {
                "vm_addr": "192.168.220.159:22",
            },
            dataType: "jsonp",
            cache: false,
        }).done(function(data) {
            var json = data;
            if (typeof(data) != "object") {
                json = $.parseJSON(data);
            }
            if (json.ok) {
                console.log("en_addr:", json.data.sshd_addr);
                login(json.data.sshd_addr, "test", "123456");
            } else {
                alert("登陆失败,请确认您的主机信息。");
            }
        }).fail(function() {
            alert("未知失败,请联系管理员。");
        });
    };


    //注意,如果远程主机的访问地址是以域名或主机形式出现的,可以执行上面步骤后,再调用本方法。具体登陆地址端口请根据实际情况更改.
    var login = function(enVMAddr, username, password) {
        $.ajax({
            url: "http://a.com:8081/console/login?rnd=" + Math.random(),
            method: "POST",
            data: {
                "vm_addr": enVMAddr,
                "user_name": username,
                "user_pwd": password
            },
            dataType: "jsonp",
            cache: false,
        }).done(function(data) {
            var json = data;
            if (typeof(data) != "object") {
                json = $.parseJSON(data);
            }
            if (json.ok) {
                location.href = "http://a.com:8081" + json.data;
            } else {
                alert("登陆失败,请确认您的登陆信息。");
            }
        }).fail(function() {
            alert("未知失败,请联系管理员。");
        });
    };
</script>
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright (c) 2016, jcpt/gome.com Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

golang版本 cassandra CQL远程查询工具 展开 收起
Go
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/tianyuliang/cloudcds-go-console.git
git@gitee.com:tianyuliang/cloudcds-go-console.git
tianyuliang
cloudcds-go-console
cloudcds-go-console
dev

搜索帮助