Merge pull request #1538 from wojiushixiaobai/docs

[Update]修改文档

docs/faq.rst

@@ -145,4 +145,23 @@ FAQ
 ::
 
     # 普通用户联系管理员关闭MFA，登录成功后用户在个人信息里面重新绑定.
-    # 如果管理员遗失无法登陆, 修改user_user表对应用户的otp_level为0, 重新登陆绑定即可
+    # 如果管理员遗失无法登陆, 修改数据库 user_user 表对应用户的 otp_level 为 0 , 重新登陆绑定即可
+    # 如果在系统设置里面开启的 MFA 二次认证 ，需要修改数据库 settings 表 SECURITY_MFA_AUTH 的 value 值为 false
+
+11. 用户管理的用户与资产管理的管理用户、系统用户说明
+
+::
+
+    # 用户管理里面的用户是登录 Jumpserver 使用的，类似 用户使用自己的阿里云账户 登录 阿里云平台
+    # 资产管理下面的 管理用户 和 系统用户 都是资产的登录账户，管理用户是 Jumpserver 调用，系统用户是给 普通用户 登录资产使用的账户
+    # 管理用户是给 Jumpserver 使用，相当于服务账户，用来检测资产的存活，硬件信息，推送系统用户等，后期还会用来执行命令等
+    # 系统用户是给 使用Jumpserver登录资产的人 使用，就像 你 我 一样的人，这个人先要登录 Jumpserver ，然后使用 系统用户 连接资产
+    以阿里云例：先登录阿里云平台，看到资产后使用资产上面的账户登录资产。
+    Jumpserver：先登录Jumpserver，看到资产后使用系统用户登录资产，一个意思。
+
+12. 资产授权说明
+
+::
+
+    # 资产授权就是把 系统用户关联到用户 并授权到 对应的资产
+    # 用户只能看到自己被授权的资产

docs/faq_install.rst

@@ -51,21 +51,27 @@
     $ pip uninstall django-celery-beat
     $ pip install django-celery-beat
 
-7. 执行./jms start all 后一直卡在 beat: Waking up in 1.00 minute.
+7. 执行 ./jms start all 后一直卡在 beat: Waking up in 1.00 minute.
 
 ::
 
     # 如果没有error提示进程无法启动，那么这是正常现象
     # 如果不想在前台启动，可以使用 ./jms start all -d 在后台启动
 
-8. 启动 jumpserver 后，访问 8080 端口页面显示不正常
+8. 执行 ./jms start all 后提示 WARNINGS: ?: (mysql.W002) MySQL Strict Mode is not set for database connection 'default' ...
+
+::
+
+    # 这是严格模式的警告，可以参考后面的url解决，或者忽略
+
+9. 启动 jumpserver 后，访问 8080 端口页面显示不正常
 
 ::
 
     # 这是因为你在 config.py 里面设置了 DEBUG = False
     # 跟着教程继续操作，后面搭建 nginx 代理即可正常访问
 
-9. 执行 ./cocod start 后提示 No module named 'jms'
+10. 执行 ./cocod start 后提示 No module named 'jms'
 
 ::
 
@@ -80,7 +86,7 @@
     $ pip install -r requirements.txt
     # 然后重新执行 ./jms start 即可
 
-10. 执行 ./cocod start 后提示 Failed register terminal jzsas exist already
+11. 执行 ./cocod start 后提示 Failed register terminal xxxx exist already
 
 ::
 
@@ -90,7 +96,7 @@
     $ rm /opt/coco/keys/.access_key  # coco, 如果你是按文档安装的，key应该在这里，如果不存在key文件直接下一步
     $ ./cocod start -d  # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册
 
-11. 执行 ./cocod start 后提示 Failed register terminal unknow: xxxx
+12. 执行 ./cocod start 后提示 Failed register terminal unknow: xxxx
 
 ::
 
@@ -104,7 +110,7 @@
 
     # 保存后重新执行 ./cocod start 即可
 
-12. 通过 nginx 代理的端口访问 jumpserver 页面显示不正常
+13. 通过 nginx 代理的端口访问 jumpserver 页面显示不正常
 
 ::
 
@@ -160,7 +166,7 @@
 
     ...
 
-13. 访问 luna 页面提示 Luna是单独部署的一个程序，你需要部署luna，coco，配置nginx做url分发...
+14. 访问 luna 页面提示 Luna是单独部署的一个程序，你需要部署luna，coco，配置nginx做url分发...
 
 ::
 

docs/faq_linux.rst

@@ -119,7 +119,13 @@ Linux 资产连接错误排查思路
 .. image:: _static/img/faq_linux_09.jpg
 .. image:: _static/img/faq_linux_10.jpg
 
-10. 连接测试常见错误
+10. ssh 使用key 登录资产提示 所选的用户密钥未在远程主机上注册
+
+::
+
+    # 这里是信息填写错误，ip端口应该填coco服务器的ip，端口应该填coco服务的ssh端口（默认2222）
+
+11. 连接测试常见错误
 
 ::
 

docs/faq_sftp.rst

@@ -7,7 +7,7 @@ sftp 使用说明
 ::
 
     # 连接成功后，可以看到当前拥有权限的资产，打开资产，然后选择系统用户，即可到资产的 /tmp 目录
-    $ sftp -P2222 admin@192.168.244.144
+    $ sftp -P2222 admin@192.168.244.144  # Linux 语法
     $ cd 你的资产
     $ cd 你的系统用户
     # 此处即是当前资产的 /tmp 目录

docs/faq_windows.rst

@@ -16,12 +16,9 @@ Windows 资产连接错误排查思路
 ::
 
     注：连接 Windows 资产提示连接错误，您没有权限访问此连接，请按照此步骤解决
-    # 如果不在线请检查 Windows 组件是否已经正常运行
-    $ docker ps
-
-    # 如果已经正常运行，但是终端没有 guacamole 的注册请求
-    $ systemctl status firewalld  # 检查防火墙是否运行，如果防火墙运行请开放 guacamole 端口
+    # 如果终端不在线，请检查 Windows 组件是否已经正常运行，可用 docker ps 命令查询，安装文档有说明
 
+    # 重新注册 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应该在这里，如果不存在直接下一步
@@ -76,6 +73,8 @@ Windows 资产连接错误排查思路
     # 不带域的用户直接输入用户名即可，如 administrator
     # 域用户的用户名格式为 user@domain.com，如 administrator@jumpserver.org
     # 如果想让用户登录资产时自己输入资产的账户密码，可以点击系统用户的名称 点击清除认证信息
+    # 此处必须输入能正确登录 windows 资产的 账户密码
+    # 如不确实是不是因为密码或者账户信息错误导致的无法登录，可以使用清除认证信息或者手动登录功能（在系统用户处设置）
 
 .. image:: _static/img/faq_windows_04.jpg
 

docs/setup_by_centos7.rst

@@ -300,6 +300,8 @@ CentOS 7 安装文档
     $ yum makecache fast
     $ yum install docker-ce
     $ systemctl start docker
+
+    # 注意：这里需要修改下 http://<填写jumpserver的url地址> 例: http://192.168.244.144 不能使用 127.0.0.1 ，可以更换 jumpserver/guacamole:latest
     $ docker run --name jms_guacamole -d \
       -p 8081:8080 -v /opt/guacamole/key:/config/guacamole/key \
       -e JUMPSERVER_KEY_DIR=/config/guacamole/key \

docs/setup_by_ubuntu.rst

@@ -384,7 +384,7 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
     $ apt-get update
     $ apt-get install docker-ce
 
-    # 注意：这里一定要改下面命令的 jumpserver url 地址 例: http://192.168.244.144
+    # 注意：这里需要修改下 http://<填写jumpserver的url地址> 例: http://192.168.244.144 不能使用 127.0.0.1 ，可以更换 jumpserver/guacamole:latest
 
     $ docker run --name jms_guacamole -d \
       -p 8081:8080 -v /opt/guacamole/key:/config/guacamole/key \
@@ -394,8 +394,7 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
 
 这里所需要注意的是 guacamole 暴露出来的端口是 8081，若与主机上其他端口冲突请自定义一下。
 
-再次强调：修改 JUMPSERVER_SERVER 环境变量的配置，填上 Jumpserver 的内网地址, 启动成功后
-去 Jumpserver-会话管理-终端管理 接受[Gua]开头的一个注册，如果页面显示不正常可以等部署完成后再处理
+启动成功后去 Jumpserver-会话管理-终端管理 接受[Gua]开头的一个注册，如果页面显示不正常可以等部署完成后再处理
 
 
 

docs/step_by_step.rst

@@ -434,6 +434,7 @@ Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/term
 
 
     # 注意：这里需要修改下 http://<填写jumpserver的url地址> 例: http://192.168.244.144, 否则会出错, 带宽有限, 下载时间可能有点长，可以喝杯咖啡，撩撩对面的妹子
+    # 不能使用 127.0.0.1 ，可以更换 jumpserver/guacamole:latest
 
     $ docker run --name jms_guacamole -d \
       -p 8081:8080 -v /opt/guacamole/key:/config/guacamole/key \
@@ -458,6 +459,7 @@ Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/term
 ::
 
     $ vim /etc/nginx/nginx.conf
+    # CentOS 6 需要修改文件 /etc/nginx/cond.f/default.conf
 
     ... 省略
     # 把默认server配置块改成这样