Merge pull request #2499 from wojiushixiaobai/docs

[Update]更新文档

docs/admin_create_asset.rst

@@ -22,9 +22,9 @@
 
 .. code-block:: vim
 
-    # 点击页面上边的"邮件设置" TAB, 进入邮件设置页面
-    # 默认使用 25 端口, 不勾选 SSL 和 TLS;如果需要勾选 SSL, 端口需要修改成 465;如果需要勾选 TLS, 端口需要改成 587
-    # 不可以同时勾选 SSL 和 TLS,
+    # 点击页面上边的"邮件设置", 进入邮件设置页面
+    # 默认使用 25 端口, 不勾选 SSL 和 TLS; 如果需要勾选 SSL, 端口需要修改成 465; 如果需要勾选 TLS, 端口需要改成 587
+    # 不可以同时勾选 SSL 和 TLS
     # 配置邮件服务后, 点击页面的"测试连接"按钮, 如果配置正确, Jumpserver 会发送一条测试邮件到您的 SMTP 账号邮箱里面, 确定收到测试邮件后点击保存即可使用
 
 .. image:: _static/img/smtp_setting.jpg
@@ -36,7 +36,7 @@
 
     # 如果不需要使用"ldap"用户登陆 jumpserver, 可以直接跳过, 不需要设置
     # 先"测试"通过才能保存
-    # DN 和 OU 一定要完整(如 "DN:cn=Manage, ou=Jumpserver, dc=jumpserver, ou=org")
+    # DN 和 OU 一定要完整(如 "DN:cn=Manage,ou=Jumpserver,dc=jumpserver,ou=org")
     # 注：可借用第三方 gui 工具查看 ldap 用户的属性, 新版本已经支持中文名登录, 即cn=中文也可正常使用
 
 .. image:: _static/img/ldap_setting.jpg
@@ -245,7 +245,8 @@
 
 .. code-block:: vim
 
-    注：保存信息后点击"测试连接", 确定设置无误后到资产列表添加需要使用网关登录的资产即可。
+    注: 保存信息后点击"测试连接", 确定设置无误后到资产列表添加需要使用"网关"登录的资产即可。
+    注: "Windows资产"可以使用"ssh网关"
 
 .. image:: _static/img/create_asset02.jpg
 

docs/faq.rst

@@ -29,40 +29,15 @@ FAQ
     # 资产管理里面的系统用户 是jumpserver用户连接资产需要的登录账户, Linux资产可以自动推送该系统用户到资产上,
     Windows需要指定资产上已经创建的系统用户
 
-2. input/output error, 通常jumpserver所在服务器字符集问题
-
-.. code-block:: shell
-
-    # Centos7
-    $ 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
-
-    # Ubuntu
-    $ apt-get install language-pack-zh-hans
-    $ echo 'LANG="zh_CN.UTF-8"' > /etc/default/locale
-
-    如果任然报input/output error, 尝试执行 yum update 后重启服务器(仅测试中参考使用, 实际运营服务器请谨慎操作)
-
-3. luna 无法访问
-
-.. code-block:: vim
-
-    # Luna 打开网页提示403 Forbidden错误, 一般是nginx配置文件的luna路径不正确或者下载了源代码, 请重新下载编译好的代码
-    # Luna 打开网页提示502 Bad Gateway错误, 一般是selinux和防火墙的问题, 请根据nginx的errorlog来检查
-
-4. 录像问题
+2. luna 无法访问
 
 .. code-block:: vim
 
-    # 默认录像存储位置在jumpserver/data/media  可以通过映射或者软连接方式来使用其他目录
+    # 访问 Web终端 提示 Luna是单独部署的一个程序, 请不要通过 8080 端口访问 jumpserver, 通过 nginx 代理端口进行访问
+    # 访问 Web终端 提示 403 Forbidden错误, 一般是nginx配置文件的luna路径不正确或者下载了源代码, 请重新下载编译好的代码
+    # 访问 Web终端 提示 502 Bad Gateway错误, 一般是selinux和防火墙的问题, 请根据nginx的errorlog来检查
 
-    # 录像和命令记录存储到其他位置, 可以到 Jumpserver 系统设置-终端设置 里面进行设置
-
-    # 修改后, 需要修改在Jumpserver 会话管理-终端管理 修改terminal的配置 录像存储 命令记录
-    # 注意, 命令记录需要所有保存地址都正常可用, 否则 历史会话 和 命令记录 页面无法正常访问
-
-5. 在终端修改管理员密码及新建超级用户
+3. 在终端修改管理员密码及新建超级用户
 
 .. code-block:: shell
 
@@ -83,7 +58,7 @@ FAQ
     > u.reset_password('password')  # password 为你要修改的密码
     > u.save()
 
-6. 修改登录超时时间(默认 10 秒)
+4. 修改 SSH 资产登录超时时间(TIMEOUT 默认 10 秒)
 
 .. code-block:: shell
 
@@ -92,14 +67,12 @@ FAQ
     # 把 SSH_TIMEOUT: 15 修改成你想要的数字 单位为：秒
     SSH_TIMEOUT: 60
 
-7. 设置浏览器过期
+5. 设置浏览器会话过期
 
 .. code-block:: shell
 
     $ vi /opt/jumpserver/config.yml
 
-.. code-block:: yaml
-
     # 找到如下行(可参考 django 设置 session 过期时间), 修改你要的设置即可
     # SESSION_COOKIE_AGE: 86400
     # SESSION_EXPIRE_AT_BROWSER_CLOSE: false
@@ -110,14 +83,14 @@ FAQ
 
     # 86400 单位是秒(s)
 
-8. 资产授权说明
+6. 资产授权说明
 
 .. code-block:: vim
 
     资产授权就是把 系统用户关联到用户 并授权到 对应的资产
     用户只能看到自己被授权的资产
 
-9. Web Terminal 页面经常需要重新刷新页面才能连接资产
+7. Web Terminal 页面经常需要重新刷新页面才能连接资产
 
 .. code-block:: nginx
 
@@ -194,7 +167,7 @@ FAQ
         }
     }
 
-10. 连接资产时提示 System user <xxx> and asset <xxx> protocol are inconsistent.
+8. 连接资产时提示 System user <xxx> and asset <xxx> protocol are inconsistent.
 
 .. code-block:: shell
 
@@ -214,7 +187,7 @@ FAQ
     >>> exit()
 
 
-11. 重启服务器后无法访问 Jumpserver, 页面提示502 或者 403等
+9. 重启服务器后无法访问 Jumpserver, 页面提示502 或者 403等
 
 .. code-block:: shell
 
@@ -235,17 +208,8 @@ FAQ
 
     $ setsebool -P httpd_can_network_connect 1  # 设置 selinux 允许 http 访问
 
-12. 生成随机 SECRET_KEY
-
-.. code-block:: shell
-
-    $ source /opt/py3/bin/activate
-    $ cd /opt/jumpserver/apps
-    $ python manage.py shell
-    >>> from django.core.management.utils import get_random_secret_key
-    >>> get_random_secret_key()
 
-13. 传递明文数据到 Jumpserver 数据库(数据导入)
+10. 传递明文数据到 Jumpserver 数据库(数据导入)
 
 .. code-block:: shell
 

docs/faq_ldap.rst

@@ -11,7 +11,7 @@ LDAP 使用说明
     LDAP地址  ldap://serverurl:389  或者  ldaps://serverurl:636(需要勾选ssl)
     # 此处是设置LDAP的服务器,推荐使用IP, 防止解析问题
 
-    绑定DN  cn=admin,dc=jumpserver,dc=org
+    绑定DN  cn=administrator,cn=Users,dc=jumpserver,dc=org
     # 这里是设置认证用户的信息, jumpserver会使用这个用户去校验ldap的信息是否正确
 
     密码   # 上面认证用户的密码

docs/faq_rdp.rst

@@ -30,9 +30,12 @@ RDP 协议资产连接错误排查思路
     # docker 部署请直接删除容器后重建, 记得一定要先在 终端管理 删除不在线的组件
     $ docker stop jms_guacamole
     $ docker rm jms_guacamole
+
+    # http://<Jumpserver_url> 指向 jumpserver 的服务url, 如 http://192.168.244.144:8080
+    # BOOTSTRAP_TOKEN 为 Jumpserver/config.yml 里面的 BOOTSTRAP_TOKEN
     $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=xxxxxx jumpserver/jms_guacamole:1.4.8
 
-    # 正常运行后到Jumpserver 会话管理-终端管理 里面查看 gua 的状态是否为绿色
+    # 正常运行后到Jumpserver 会话管理-终端管理 里面查看 gua 的状态是否为绿色(等待大概5s后刷新页面)
 
 2. 登录要连接的windows资产, 检查远程设置和防火墙设置
 

docs/faq_ssh.rst

@@ -26,6 +26,9 @@ SSH 协议资产连接错误排查思路
     # docker 部署请直接删除容器后重建, 记得一定要先在 终端管理 删除不在线的组件
     $ docker stop jms_coco
     $ docker rm jms_coco
+
+    # http://<Jumpserver_url> 指向 jumpserver 的服务url, 如 http://192.168.244.144:8080
+    # BOOTSTRAP_TOKEN 为 Jumpserver/config.yml 里面的 BOOTSTRAP_TOKEN
     $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=xxxxxx jumpserver/jms_coco:1.4.8
 
     # 正常运行后到Jumpserver 会话管理-终端管理 里面查看 coco 的状态是否为绿色
@@ -52,36 +55,32 @@ SSH 协议资产连接错误排查思路
     # 检查 coco 的 ws 端口(默认 5000)
     # 检查 nginx 配置的 socket.io 设置是否有误
 
+    $ cd /opt/coco
+    $ source /opt/py3/bin/activate
+    $ ./cocod stop
+    $ ps -ef | grep cocod | awk '{print $2}' | xargs kill -9
+    $ ./cocod start
+
+    # docker容器部署的coco组件请检查防火墙是否无误, 然后进入容器处理
+    $ docker exec it jms_coco /bin/bash
+    $ cd /opt/coco
+    $ source /opt/py3/bin/activate
+    $ ./cocod stop
+    $ ps -ef | grep cocod | awk '{print $2}' | xargs kill -9
+    $ ./cocod start
+
 .. image:: _static/img/faq_linux_03.jpg
 
 4. 登录资产提示 Authentication failed
 
 .. code-block:: vim
 
-    # 请检查推送
+    # 请检查推送 或 系统用户 是否正确, 可以把系统用户设置成手动登录测试
     # 在 资产管理-系统用户 下, 点击相应的 系统用户名称 可以看到 系统用户详情, 右边可以测试
 
 .. image:: _static/img/faq_linux_04.jpg
 
-5. 推送成功后无法登录资产, 或者推送的系统用户 id 不正确 home 目录权限错误
-
-.. code-block:: vim
-
-    # 登录该资产, 删除掉错误权限的用户, 然后重新推送即可
-
-6. coco 启动时报错 Failed register terminal unknow: xxx-xxx.xxx
-
-.. code-block:: shell
-
-    # 这是因为当前系统的 hostname 有 coco 不支持的字符, 需要手动指定 coco 的 NAME
-    $ cd /opt/coco/
-    $ vi config.yml
-
-    # 项目名称, 会用来向Jumpserver注册, 识别而已, 不能重复
-    # NAME: {{ Hostname }}
-    NAME: localhost
-
-7. 测试可连接性 及 更新硬件信息
+5. 测试可连接性 及 更新硬件信息
 
 .. code-block:: vim
 
@@ -90,7 +89,7 @@ SSH 协议资产连接错误排查思路
 .. image:: _static/img/faq_linux_05.jpg
 .. image:: _static/img/faq_linux_06.jpg
 
-8. 管理用户 测试可连接性
+6. 管理用户 测试可连接性
 
 .. code-block:: vim
 
@@ -99,7 +98,7 @@ SSH 协议资产连接错误排查思路
 .. image:: _static/img/faq_linux_07.jpg
 .. image:: _static/img/faq_linux_08.jpg
 
-9. 系统用户 推送 测试资产可连接性
+7. 系统用户 推送 测试资产可连接性
 
 .. code-block:: vim
 
@@ -108,13 +107,13 @@ SSH 协议资产连接错误排查思路
 .. image:: _static/img/faq_linux_09.jpg
 .. image:: _static/img/faq_linux_10.jpg
 
-10. ssh 使用key 登录资产提示 所选的用户密钥未在远程主机上注册
+8. ssh 使用key 登录资产提示 所选的用户密钥未在远程主机上注册
 
 .. code-block:: vim
 
     # 这里是信息填写错误, ip端口应该填coco服务器的ip, 端口应该填coco服务的ssh端口(默认2222)
 
-11. 清理celery产生的数据(无法正常推送及连接资产, 一直显示........等可以使用, 请确定字符集是zh_CN.UTF-8)
+9. 清理celery产生的数据(无法正常推送及连接资产, 一直显示........等可以使用, 请确定字符集是zh_CN.UTF-8)
 
 .. code-block:: shell
 
@@ -124,7 +123,7 @@ SSH 协议资产连接错误排查思路
 
     # 如果任然异常, 手动结束所有jumpserver进程, 然后kill掉未能正常结束的jumpserver相关进程, 在重新启动jumpserver即可
 
-12. 连接测试常见错误
+10. 连接测试常见错误
 
 .. code-block:: vim
 

docs/setup_by_fast.rst

@@ -15,14 +15,8 @@
 .. code-block:: shell
 
     $ echo -e "\033[31m 1. 防火墙 Selinux 设置 \033[0m" \
-      && systemctl enable firewalld \
-      && systemctl start firewalld \
-      && firewall-cmd --zone=public --add-port=80/tcp --permanent \
-      && firewall-cmd --zone=public --add-port=2222/tcp --permanent \
-      && firewall-cmd --permanent --add-rich-rule="rule family="ipv4" source address="172.17.0.0/16" port protocol="tcp" port="8080" accept" \
-      && firewall-cmd --reload \
-      && setenforce 0 \
-      && sed -i "s/enforcing/disabled/g" /etc/selinux/config
+      && if [ "$(systemctl status firewalld | grep running)" != "" ]; then firewall-cmd --zone=public --add-port=80/tcp --permanent; firewall-cmd --zone=public --add-port=2222/tcp --permanent; firewall-cmd --permanent --add-rich-rule="rule family="ipv4" source address="172.17.0.0/16" port protocol="tcp" port="8080" accept"; firewall-cmd --reload; fi \
+      && if [ "$(getenforce)" != "Disabled" ]; then setenforce 0; sed -i "s/enforcing/disabled/g" /etc/selinux/config; fi
 
 .. code-block:: shell