Merge pull request #1376 from wojiushixiaobai/docs

[Update]更新文档

docs/change_log.rst

@@ -193,3 +193,14 @@
 * 支持二次认证(Google Authenticator)
 * 修复一些bug
 * 优化第一次登录页面
+
+1.3.1
+------------------------
+2018年5月24日
+
+* 用户授权节点逻辑更改
+* 去掉window无用信息
+* 修复节点创建bug
+* 创建节点 从0开始，新节点0 新节点1
+* 修复拖动节点引起的父节点异常
+* 资产树增加视图，只显示本节点资产和显示子节点资产

docs/faq.rst

@@ -3,6 +3,7 @@ FAQ
 .. toctree::
    :maxdepth: 1
 
+   Linux 资产连接说明 <faq_linux.rst>
    Windows 资产连接说明 <faq_windows.rst>
    Windows sftp使用说明 <faq_sftp.rst>
    二次认证（Google Auth）入口说明 <faq_googleauth.rst>
@@ -178,7 +179,14 @@ FAQ
         # 新建超级用户的命令如下命令
         $ python manage.py createsuperuser --username=user --email=user@domain.com
 
-    (11). 清理celery产生的数据(无法正常推送及连接资产可以使用)
+    (11). 清理celery产生的数据(无法正常推送及连接资产，一直显示........等可以使用，请确定字符集是zh_CN.UTF-8)
+        # 检测 /etc/locale.conf 是否是 LANG="zh_CN.UTF-8"
+        $ cat /etc/locale.conf
+        # 如果不是，请修改，注，本例只是以CentOS 7举例，其他的linux请更换路径
+        $ localedef -c -f UTF-8 -i zh_CN zh_CN.UTF-8
+        $ export LC_ALL=zh_CN.UTF-8
+        $ echo 'LANG="zh_CN.UTF-8"' > /etc/locale.conf
+
         $ source /opt/py3/bin/activate
         $ cd /opt/jumpserver/apps
         $ python manage.py shell
@@ -217,11 +225,3 @@ FAQ
         # 如下，设置关闭浏览器 cookie 失效，则修改为
         # SESSION_COOKIE_AGE = CONFIG.SESSION_COOKIE_AGE or 3600 * 24
         SESSION_EXPIRE_AT_BROWSER_CLOSE = True
-
-    (15.) 测试连接、推送、硬件刷新一直显示.....................
-        # 检测 /etc/locale.conf 是否是 LANG="zh_CN.UTF-8"
-        $ cat /etc/locale.conf
-        # 如果不是，请修改
-        $ localedef -c -f UTF-8 -i zh_CN zh_CN.UTF-8
-        $ export LC_ALL=zh_CN.UTF-8
-        $ echo 'LANG="zh_CN.UTF-8"' > /etc/locale.conf

docs/faq_linux.rst

+Linux 资产连接说明
+----------------------------
+
+1. 检查终端是否在线
+
+::
+
+    # 确定已经在Jumpserver后台 会话管理-终端管理 里接受 coco 的注册
+
+    # 如果不在线请检查 Linux 组件是否正常运行，箭头指示处 绿色表示正常，红色表示异常
+    $ ps -ef | grep cocod | grep -v grep
+    $ netstat -an | grep ":2222" | grep -v grep
+
+    # 如果不在线可以尝试重启 coco
+    $ source /opt/py3/bin/activate
+    $ cd /opt/coco
+    $ ./cocod stop  # 请用 ps 命令确定 coco 进程已经退出后再继续操作
+    $ ./cocod start  # 后台运行使用 -d 参数./cocod start -d
+
+    # 如果重启后 coco 任然不在线，请重新注册
+    # 在Jumpserver后台 会话管理-终端管理 删掉 coco 的注册
+    $ cd /opt/coco && ./cocod stop
+    $ rm /opt/coco/keys/.access_key  # coco, 如果你是按文档安装的，key应该在这里
+    $ ./cocod start -d  # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册
+
+.. image:: _static/img/faq_linux_01.jpg
+
+2. 访问 luna 界面不显示资产信息
+
+::
+
+    # 确定已经授权资产给当前登录用户
+    # 确定 umpserver 的版本与 luna 的版本一致，如不一致请参考升级文档进行处理
+
+    # Jumpserver 版本可在 jumpserver页面右下角 看到
+    # Luna 版本可在 luna页面左下角 看到
+
+    # 注：更新后请清理浏览器缓存后再访问
+
+.. image:: _static/img/faq_linux_02.jpg
+
+3. 访问 Linux 资产无任何提示
+
+::
+
+    # 请参考第一条检查终端是否在线
+
+.. image:: _static/img/faq_linux_03.jpg
+
+4. 登录资产提示 Authentication failed
+
+::
+
+    # 请检查推送
+    # 在 资产管理-系统用户 下，点击相应的 系统用户名称 可以看到 系统用户详情，右边可以测试
+
+.. image:: _static/img/faq_linux_04.jpg
+
+5. 推送成功后无法登录资产，或者推送的系统用户 id 不正确 home 目录权限错误
+
+::
+
+    # 登录该资产，删除掉错误权限的用户，然后重新推送即可
+
+6. coco 启动时报错 Failed register terminal unknow: xxx-xxx.xxx
+
+::
+
+    # 这是因为当前系统的 hostname 有 coco 不支持的字符，需要手动指定 coco 的 NAME
+    $ cd /opt/coco/
+    $ vim conf.py
+
+    # 项目名称, 会用来向Jumpserver注册, 识别而已, 不能重复
+    # NAME = "localhost"
+    NAME = "localhost"
+
+7. 测试可连接性 及 更新硬件信息
+
+::
+
+    # 注意不要拦截窗口
+
+.. image:: _static/img/faq_linux_05.jpg
+.. image:: _static/img/faq_linux_06.jpg
+
+8. 管理用户 测试可连接性
+
+::
+
+    # 注意不要拦截窗口
+
+.. image:: _static/img/faq_linux_07.jpg
+.. image:: _static/img/faq_linux_08.jpg
+
+9. 系统用户 推送 测试资产可连接性
+
+::
+
+    # 注意不要拦截窗口
+
+.. image:: _static/img/faq_linux_09.jpg
+.. image:: _static/img/faq_linux_10.jpg
+
+
+其他问题可参考 `FAQ <faq.html>`_

docs/faq_windows.rst

@@ -11,10 +11,21 @@ Windows 资产连接说明
     # 如果已经正常运行，但是终端没有 guacamole 的注册请求
     $ systemctl status firewalld  # 检查防火墙是否运行，如果防火墙运行请开放 guacamole 端口
 
-    # 如果之前删除过 guacamole 容器，请检查 key 是否已经删除
-    $ rm -rf /opt/guacamole/key/*  # 默认在这里
-
-    # 如果未安装 guacamole 请参照安装文档的 windows 组件部分进行处理
+    $ 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地址> \
+      registry.jumpserver.org/public/guacamole:latest
+
+    # 如果registry.jumpserver.org/public/guacamole:latest下载很慢，可以换成jumpserver/guacamole:latest
+
+    # 正常运行后到Jumpserver 会话管理-终端管理 里面接受gua注册
+    $ docker restart jms_guacamole  # 如果接受注册后显示不在线，重启gua就好了
 
 .. image:: _static/img/faq_windows_01.jpg
 
@@ -69,3 +80,5 @@ Windows 资产连接说明
     # 直接拖拽文件到 windows 窗口即可，文件上传后在 Guacamole RDP上的 G 目录查看
 
 .. image:: _static/img/faq_windows_08.jpg
+
+其他问题可参考 `FAQ <faq.html>`_

docs/setup_by_ubuntu.rst

@@ -54,8 +54,9 @@
 
 ::
 
-    $ git clone git://github.com/kennethreitz/autoenv.git ~/.autoenv
-    $ echo 'source ~/.autoenv/activate.sh' >> ~/.bashrc
+    $ cd /opt
+    $ git clone git://github.com/kennethreitz/autoenv.git
+    $ echo 'source /opt/autoenv/activate.sh' >> ~/.bashrc
     $ source ~/.bashrc
 
 二. 安装 Jumpserver

docs/step_by_step.rst

@@ -69,8 +69,9 @@ Yum 加速设置请参考 <http://mirrors.163.com/.help/centos.html>
 
 ::
 
-    $ git clone git://github.com/kennethreitz/autoenv.git ~/.autoenv
-    $ echo 'source ~/.autoenv/activate.sh' >> ~/.bashrc
+    $ cd /opt
+    $ git clone git://github.com/kennethreitz/autoenv.git
+    $ echo 'source /opt/autoenv/activate.sh' >> ~/.bashrc
     $ source ~/.bashrc
 
 二. 安装 Jumpserver

docs/upgrade.rst

@@ -5,12 +5,12 @@
 
 ::
 
-    # 新版本更新了自动升级脚本，升级只需要到 utils 目录下执行 sh upgrade.sh 即可
+    # 新版本更新了自动升级脚本，升级只需要到 utils 目录下执行 sh upgrade.sh 即可，请做好备份
     $ git pull
     $ pip install -r requirements/requirements.txt  # 如果使用其他源下载失败可以使用 -i 参数指定源
     $ cd utils && sh make_migrations.sh
 
-    # 1.0.x 升级 1.2.0 需要执行迁移脚本（新版本授权管理更新）
+    # 1.0.x 升级 1.2.0及以后的版本 需要执行迁移脚本（新版本授权管理更新）
     $ sh 2018_04_11_migrate_permissions.sh
  
 2. 升级 Coco（如果是新开的终端，别忘了 source /opt/py3/bin/activate）