Merge pull request #1982 from wojiushixiaobai/docs

[Update]Docs

docs/distributed_04.rst

@@ -45,17 +45,8 @@
     $ python3.6 -m venv /opt/py3
     $ source /opt/py3/bin/activate
 
-    # 配置 autoenv
-    $ git clone git://github.com/kennethreitz/autoenv.git
-    $ echo 'source /opt/autoenv/activate.sh' >> ~/.bashrc
-    $ source ~/.bashrc
-
     # 下载 Jumpserver
     $ git clone https://github.com/jumpserver/jumpserver.git
-    $ echo "source /opt/py3/bin/activate" > /opt/jumpserver/.env
-    $ cd /opt/jumpserver && git checkout master && git pull
-    # 首次进入 jumpserver 文件夹会有提示，按 y 即可
-    # Are you sure you want to allow this? (y/N) y
 
     # 安装依赖 RPM 包
     $ yum -y install $(cat /opt/jumpserver/requirements/rpm_requirements.txt)

docs/faq_rdp.rst

@@ -18,25 +18,26 @@ RDP 协议资产连接错误排查思路
 ::
 
     注：连接 Windows 资产提示连接错误，您没有权限访问此连接，请按照此步骤解决
-    # 如果终端不在线，请检查 Windows 组件是否已经正常运行，可用 docker ps 命令查询，安装文档有说明
+    # 如果终端不在线，请检查 Windows 组件是否已经正常运行
 
-    # 重新注册 Windows 组件
+    # 如果重启后任然不在线，请重新注册 Windows 组件
     # 在Jumpserver后台 会话管理-终端管理 删掉 guacamole 的注册
-    $ docker stop jms_guacamole  # 如果名称更改过或者不对，请使用docker ps 查询容器的 CONTAINER ID ，然后docker stop <CONTAINER ID>
-    $ docker rm jms_guacamole  # 如果名称更改过或者不对，请使用docker ps -a 查询容器的 CONTAINER ID ，然后docker rm <CONTAINER ID>
-    $ rm /opt/guacamole/key/*  # guacamole, 如果你是按文档安装的，key应该在这里，如果不存在直接下一步
-    $ systemctl stop docker
-    $ systemctl start docker
-    $ docker run --name jms_guacamole -d \
-      -p 8081:8080 -v /opt/guacamole/key:/config/guacamole/key \
-      -e JUMPSERVER_KEY_DIR=/config/guacamole/key \
-      -e JUMPSERVER_SERVER=http://<填写jumpserver的url地址> \
-      jumpserver/guacamole:latest
-
-    # 如果镜像不是jumpserver/guacamole 请更换 registry.jumpserver.org/public/guacamole
+    # 必须到 Jumpserver后台 会话管理-终端管理  删掉 guacamole 的注册
+    # 一定要先到 Jumpserver后台 会话管理-终端管理  删掉 guacamole 的注册
+
+    # 正常部署参照此步骤解决
+    $ /etc/init.d/guacd stop
+    $ sh /config/tomcat8/bin/shutdown.sh
+    $ rm -rf /config/guacamole/keys/*
+    $ /etc/init.d/guacd start
+    $ sh /config/tomcat8/bin/startup.sh
+
+    # docker 部署请直接删除容器后重建，记得一定要先在 终端管理 删除不在线的组件
+    $ docker stop jms_guacamole
+    $ docker rm jms_guacamole
+    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> wojiushixiaobai/guacamole:1.4.3
 
     # 正常运行后到Jumpserver 会话管理-终端管理 里面接受gua注册
-    $ docker restart jms_guacamole  # 如果接受注册后显示不在线，重启gua就好了
 
 2. 登录要连接的windows资产，检查远程设置和防火墙设置
 
@@ -47,7 +48,7 @@ RDP 协议资产连接错误排查思路
 
     # Windows防火墙-高级设置-入站规则 把远程桌面开头的选项 右键-启用规则
     # Windows 7/2008 启用 远程桌面(TCP-In)
-    # Windows 8/10/2012 启用 远程桌面-用户模式(TCP-In) 远程桌面-用户模式(UDP-In)
+    # Windows 8/10/2012 启用 远程桌面-用户模式(TCP-In)
 
 3. 登录要连接的windows资产，检查用户和IP信息（Windows目前还不支持推送，所以必须使用资产上面已存在的用户进行登录）
 
@@ -104,11 +105,4 @@ RDP 协议资产连接错误排查思路
 
 .. image:: _static/img/faq_windows_08.jpg
 
-10. Windows 无法录像
-
-::
-
-    # 把 docker stop 后重新启动就好了，记得启动 guacamole
-
-
 其他问题可参考 `FAQ <faq.html>`_

docs/faq_ssh.rst

@@ -18,22 +18,23 @@ SSH 协议资产连接错误排查思路
     # 确定已经在Jumpserver后台 会话管理-终端管理 里接受 coco 的注册
 
     # 如果不在线请检查 Linux 组件是否正常运行，箭头指示处 绿色表示正常，红色表示异常
-    $ ps -ef | grep cocod | grep -v grep
-    $ cat /opt/coco/logs/coco.log  # 检查有没有 error
-
-    # 如果不在线可以尝试重启 coco
-    $ source /opt/py3/bin/activate
-    $ cd /opt/coco
-    $ ./cocod stop  # 请用 ps 命令确定 coco 进程已经退出后再继续操作
-    $ ./cocod start  # 后台运行使用 -d 参数./cocod start -d
 
     # 如果重启后 coco 任然不在线，请重新注册
     # 在Jumpserver后台 会话管理-终端管理 删掉 coco 的注册
     # 必须到 Jumpserver后台 会话管理-终端管理  删掉 coco 的注册
     # 一定要先到 Jumpserver后台 会话管理-终端管理  删掉 coco 的注册
+
+    # 正常部署请参照此步骤解决
     $ cd /opt/coco && ./cocod stop
     $ rm /opt/coco/keys/.access_key  # coco, 如果你是按文档安装的，key应该在这里，如果不存在，直接下一步
-    $ ./cocod start -d  # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册
+    $ ./cocod start -d
+
+    # docker 部署请直接删除容器后重建，记得一定要先在 终端管理 删除不在线的组件
+    $ docker stop jms_coco
+    $ docker rm jms_coco
+    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> wojiushixiaobai/coco:1.4.3
+
+    # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册
 
 2. 访问 luna 界面不显示资产信息
 

docs/quickinstall.rst

-一站式、分布式、组件离线安装
+一站式、分布式安装文档
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 可用于生产环境参考安装文档
 
@@ -23,7 +23,6 @@
    :maxdepth: 1
 
    在线安装文档 <setup_by_centos7.rst>
-   组件离线安装文档 <setup_by_local.rst>
 
 分布式部署文档（基于CentOS 7）
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/start_automatically.rst

 开机自启
 ------------------
 
-设置 Jumpserver 自启
+正常部署设置自启
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ::
 
@@ -59,3 +60,62 @@
     # 写入 rc.local
     $ chmod +x /etc/rc.local
     $ echo "sh /opt/start_jms.sh" >> /etc/rc.local
+
+
+Docker 组件部署设置自启
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+    # 启动
+    $ vim /opt/start_jms.sh
+
+    #!/bin/bash
+    set -e
+
+    # 项目安装位置，默认是/opt
+    Project=/opt
+
+    pid=`ps -ef | grep -v grep | egrep '(gunicorn|celery|beat)' | awk '{print $2}'`
+    if [ "$pid" != "" ]; then
+        echo -e "\033[31m 检测到 Jumpserver 进程未退出，结束中 \033[0m"
+        cd /opt && sh stop_jms.sh
+        sleep 5s
+        pid1=`ps -ef | grep -v grep | egrep '(gunicorn|celery|beat)' | awk '{print $2}'`
+        if [ "$pid1" != "" ]; then
+            echo -e "\033[31m 检测到 Jumpserver 进程任未退出，强制结束中 \033[0m"
+            kill -9 ${pid1}
+        fi
+    fi
+
+    echo -e "\033[31m 正常启动 Jumpserver ... \033[0m"
+    source $Project/py3/bin/activate
+    cd $Project/jumpserver && ./jms start -d
+    docker start jms_coco
+    docker start jms_guacamole
+
+    exit 0
+
+::
+
+    # 停止
+    $ vim /opt/stop_jms.sh
+
+    #!/bin/bash
+    set -e
+
+    # 项目安装位置，默认是/opt
+    Project=/opt
+
+    docker stop jms_coco
+    docker stop jms_guacamole
+    source $Project/py3/bin/activate
+    cd $Project/jumpserver && ./jms stop
+
+    exit 0
+
+::
+
+    # 写入 rc.local
+    $ chmod +x /etc/rc.local
+    $ echo "sh /opt/start_jms.sh" >> /etc/rc.local

docs/upgrade.rst

@@ -137,6 +137,23 @@
     $ /etc/init.d/guacd start
     $ sh /config/tomcat8/bin/startup.sh
 
+5. Docker 部署 coco guacamole 升级说明
+
+::
+
+    # 先到 Web 会话管理 - 终端管理 删掉所有组件
+    $ docker sop jms_coco
+    $ docker stop jms_guacamole
+    $ docker rm jms_coco
+    $ docker rm jms_guacamole
+    $ docker pull docker pull wojiushixiaobai/coco:1.4.3
+    $ docker pull wojiushixiaobai/guacamole:1.4.3
+    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> wojiushixiaobai/coco:1.4.3
+    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> wojiushixiaobai/guacamole:1.4.3
+
+    # 到 Web 会话管理 - 终端管理 接受新的注册
+
+
 切换分支或releases包升级
 -------------------------------