Merge pull request #1853 from wojiushixiaobai/docs

[Update]更新FAQ文档

docs/faq.rst

@@ -3,12 +3,12 @@ FAQ
 .. toctree::
    :maxdepth: 1
 
-   Ldap 使用说明 <faq_ldap.rst>
-   Sftp 使用说明 <faq_sftp.rst>
-   Telnet 使用说明 <faq_telnet.rst>
+   LDAP 使用说明 <faq_ldap.rst>
+   SFTP 使用说明 <faq_sftp.rst>
+   TELNET 使用说明 <faq_telnet.rst>
    安装过程 常见问题 <faq_install.rst>
-   Linux 资产连接说明 <faq_linux.rst>
-   Windows 资产连接说明 <faq_windows.rst>
+   RDP 协议资产连接说明 <faq_rdp.rst>
+   SSH 协议资产连接说明 <faq_ssh.rst>
    添加组织 及 组织管理员说明 <faq_org.rst>
    二次认证（Google Auth）入口说明 <faq_googleauth.rst>
 
@@ -48,8 +48,8 @@ FAQ
 
 ::
 
-    # Luna 打开网页提示403 Forbidden错误，一般是nginx配置文件的luna路径不正确或者luna下载了源代码，请重新下载编译好的代码
-    # Luna 打开网页提示502 Bad Gateway错误，一般是selinux和防火墙的问题，请根据nginx的errorlog来检查
+    Luna 打开网页提示403 Forbidden错误，一般是nginx配置文件的luna路径不正确或者luna下载了源代码，请重新下载编译好的代码
+    Luna 打开网页提示502 Bad Gateway错误，一般是selinux和防火墙的问题，请根据nginx的errorlog来检查
 
 4. 录像问题
 
@@ -120,29 +120,18 @@ FAQ
 
 ::
 
-    # 普通用户联系管理员关闭MFA，登录成功后用户在个人信息里面重新绑定.
-    # 如果管理员遗失无法登陆, 修改数据库 user_user 表对应用户的 otp_level 为 0 , 重新登陆绑定即可
-    # 如果在系统设置里面开启的 MFA 二次认证 ，需要修改数据库 settings 表 SECURITY_MFA_AUTH 的 value 值为 false
+    普通用户联系管理员关闭MFA，登录成功后用户在个人信息里面重新绑定.
+    如果管理员遗失无法登陆, 修改数据库 user_user 表对应用户的 otp_level 为 0 , 重新登陆绑定即可
+    如果在系统设置里面开启的 MFA 二次认证 ，需要修改数据库 settings 表 SECURITY_MFA_AUTH 的 value 值为 false
 
-10. 用户管理的用户与资产管理的管理用户、系统用户说明
-
-::
-
-    # 用户管理里面的用户是登录 Jumpserver 使用的，类似 用户使用自己的阿里云账户 登录 阿里云平台
-    # 资产管理下面的 管理用户 和 系统用户 都是资产的登录账户，管理用户是 Jumpserver 调用，系统用户是给 普通用户 登录资产使用的账户
-    # 管理用户是给 Jumpserver 使用，相当于服务账户，用来检测资产的存活，硬件信息，推送系统用户等，后期还会用来执行命令等
-    # 系统用户是给 使用Jumpserver登录资产的人 使用，就像 你 我 一样的人，这个人先要登录 Jumpserver ，然后使用 系统用户 连接资产
-    以阿里云例：先登录阿里云平台，看到资产后使用资产上面的账户登录资产。
-    Jumpserver：先登录Jumpserver，看到资产后使用系统用户登录资产，一个意思。
-
-11. 资产授权说明
+10. 资产授权说明
 
 ::
 
     # 资产授权就是把 系统用户关联到用户 并授权到 对应的资产
     # 用户只能看到自己被授权的资产
 
-12. Web Terminal 页面经常需要重新刷新页面才能连接资产
+11. Web Terminal 页面经常需要重新刷新页面才能连接资产
 
 ::
 
@@ -219,7 +208,7 @@ FAQ
         }
     }
 
-13. 连接资产时提示 System user <xxx> and asset <xxx> protocol are inconsistent.
+12. 连接资产时提示 System user <xxx> and asset <xxx> protocol are inconsistent.
 
 ::
 
@@ -239,7 +228,7 @@ FAQ
     >>> exit()
 
 
-15. 重启服务器后无法访问 Jumpserver，页面提示502 或者 403等
+13. 重启服务器后无法访问 Jumpserver，页面提示502 或者 403等
 
 ::
 
@@ -276,8 +265,9 @@ FAQ
 ::
 
     # 以导入 admin 用户 public_key 为例
-    $ $ source /opt/py3/bin/activate
+    $ source /opt/py3/bin/activate
     $ cd /opt/jumpserver/apps
+    $ python manage.py shell
     >>> from users.models import User
     >>> user = User.objects.get(username='admin')
     >>> user.public_key = '明文key'

docs/faq_googleauth.rst

@@ -5,6 +5,6 @@
 
 ::
 
-    # 关闭也是在这里，点击此处的禁用即可
-    # 部分安卓手机无法使用 Google Auth ，可以尝试使用系统自带的【扫一扫】工具
-    # 或者尝试使用第三方软件（如Microsoft Authenticator 、身份宝等）
+    关闭也是在这里，点击此处的重置即可
+    部分安卓手机无法使用 Google Auth ，可以尝试使用系统自带的【扫一扫】工具
+    或者尝试使用第三方软件（如Microsoft Authenticator 、身份宝等）

docs/faq_install.rst

@@ -5,27 +5,27 @@
 
 ::
 
-    # 一般是由于时间不同步，或者网络有问题导致的
-    # 可以尝试下载 releases 包
+    一般是由于时间不同步，或者网络有问题导致的
+    可以尝试下载 releases 包
 
 2. pip install 提示 ssl 错误
 
 ::
 
-    # 参考第一条解决
+    参考第一条解决
 
 3. pip install 提示 download 错误
 
 ::
 
-    # 一般是由于网络不好，导致下载文件失败，重新执行命令即可
-    # 如果多次重试均无效，请更换网络环境
+    一般是由于网络不好，导致下载文件失败，重新执行命令即可
+    如果多次重试均无效，请更换网络环境
 
 4. bash make_migrations.sh 时报错 from config import config as CONFIG File "/opt/jumpserver/config.py", line 38
 
 ::
 
-    # 这是由于 config.py 里面的内容格式不对，请参考安装文档的说明，把提示的内容与上一行对齐即可
+    这是由于 config.py 里面的内容格式不对，请参考安装文档的说明，把提示的内容与上一行对齐即可
 
 5. bash make_migrations.sh 时报错 Are you sure it's installed and available on your PYTHONPATH environment variable? Did you forget to activate a virtual environment?
 
@@ -55,8 +55,8 @@
 
 ::
 
-    # 如果没有error提示进程无法启动，那么这是正常现象
-    # 如果不想在前台启动，可以使用 ./jms start all -d 在后台启动
+    如果没有error提示进程无法启动，那么这是正常现象
+    如果不想在前台启动，可以使用 ./jms start all -d 在后台启动
 
 8. 执行 ./jms start all 后提示 xxx is stopped
 
@@ -70,14 +70,14 @@
 
 ::
 
-    # 这是严格模式的警告，可以参考后面的url解决，或者忽略
+    这是严格模式的警告，可以参考后面的url解决，或者忽略
 
 10. 启动 jumpserver 后，访问 8080 端口页面显示不正常
 
 ::
 
-    # 这是因为你在 config.py 里面设置了 DEBUG = False
-    # 跟着教程继续操作，后面搭建 nginx 代理即可正常访问
+    这是因为你在 config.py 里面设置了 DEBUG = False
+    跟着教程继续操作，后面搭建 nginx 代理即可正常访问
 
 11. 执行 ./cocod start 后提示 No module named 'jms'
 
@@ -178,4 +178,4 @@
 
 ::
 
-    # 请通过 nginx 代理的端口访问 jumpserver 页面，不要再直接访问 8080 端口
+    请通过 nginx 代理的端口访问 jumpserver 页面，不要再直接访问 8080 端口

docs/faq_windows.rst → docs/faq_rdp.rst

-Windows 资产连接说明
-----------------------------
+RDP 协议资产连接说明
+------------------------------
 
-Windows 资产连接错误排查思路
+RDP 协议资产连接错误排查思路
 
 ::
 

docs/faq_linux.rst → docs/faq_ssh.rst

-Linux 资产连接说明
-----------------------------
+SSH 协议资产连接说明
+--------------------------------
 
-Linux 资产连接错误排查思路
+SSH 协议资产连接错误排查思路
 
 ::
 
     (1). 检查管理用户的权限是否正确，权限需要与root权限一致
     (2). 检查资产的防火墙策略，可以在资产上面新建个用户，尝试用此用户在jumpserver服务器上进行ssh连接
-    (3). 检查资产的python，确定版本不小于2.6，不高于3.x
-    (4). 检查资产的ssh策略，确保可以被jumpserver应用访问
+    (3). 检查资产的ssh策略，确保可以被jumpserver应用访问
 
 1. 检查终端是否在线