修改文档

docs/admin_system_settings.rst

@@ -38,8 +38,8 @@
 ::
 
    # 注意下面的 testuser对应的是你ldap server上存在的用户，填写到配置中需要改为 %(user)s
-   ldapsearch -x -W -h ldap://127.0.0.1:389 -b "ou=People,dc=xxx,dc=com" -D "cn=admin,dc=xxx,dc=com" "(cn=testuser)"
-   ldapsearch -x -W -h ldap://127.0.0.1:389 -b "dc=xxx,dc=com" -D "cn=admin,dc=xxx,dc=com" "(&(cn=testuser)(objectClass=account))"
+   ldapsearch -x -W -H ldap://127.0.0.1:389 -b "ou=People,dc=xxx,dc=com" -D "cn=admin,dc=xxx,dc=com" "(cn=testuser)"
+   ldapsearch -x -W -H ldap://127.0.0.1:389 -b "dc=xxx,dc=com" -D "cn=admin,dc=xxx,dc=com" "(&(cn=testuser)(objectClass=account))"
 
    # extended LDIF
    #
@@ -67,4 +67,4 @@
 
 资产列表排序项，可以选择按主机名或者 IP 来排序，默认是按主机名排序。心跳间隔指的是 Coco 和 Gua 等终端向 Jumpserver 发送心跳信息的频率，如果 Jumpserver 长时间（1个小时）未收到 Coco 和 Gua 发送的心跳数据，Jumpserver 则认为该终端也"死掉"，在"会话管理"下的"终端管理"页面会显示该终端已掉线。
 
-.. image:: _static/img/admin_terminal_settings.jpg
\ No newline at end of file
+.. image:: _static/img/admin_terminal_settings.jpg

docs/conf.py

@@ -12,7 +12,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
+import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 import sphinx_rtd_theme
@@ -114,24 +114,42 @@ htmlhelp_basename = u'Jumpserver 文档'
 
 
 # -- Options for LaTeX output ------------------------------------------------
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
-latex_elements = {
+if on_rtd:
+    latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-
+    #'papersize': 'letterpaper',
     # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-
+    #'pointsize': '10pt',
     # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
+        'preamble': r'''
+        \hypersetup{unicode=true}
+        \usepackage{CJKutf8}
+        \DeclareUnicodeCharacter{00A0}{\nobreakspace}
+        \DeclareUnicodeCharacter{2203}{\ensuremath{\exists}}
+        \DeclareUnicodeCharacter{2200}{\ensuremath{\forall}}
+        \DeclareUnicodeCharacter{2286}{\ensuremath{\subseteq}}
+        \DeclareUnicodeCharacter{2713}{x}
+        \DeclareUnicodeCharacter{27FA}{\ensuremath{\Longleftrightarrow}}
+        \DeclareUnicodeCharacter{221A}{\ensuremath{\sqrt{}}}
+        \DeclareUnicodeCharacter{221B}{\ensuremath{\sqrt[3]{}}}
+        \DeclareUnicodeCharacter{2295}{\ensuremath{\oplus}}
+        \DeclareUnicodeCharacter{2297}{\ensuremath{\otimes}}
+        \begin{CJK}{UTF8}{gbsn}
+        \AtEndDocument{\end{CJK}}
+        ''',
+    }
+else:
+    latex_elements = {
+        'papersize': 'a4paper',
+        'utf8extra': '',
+        'inputenc': '',
+        'babel': r'''\usepackage[english]{babel}''',
+        'preamble': r'''
+        \usepackage{ctex}
+        ''',
+    }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,

docs/faq.rst

@@ -51,7 +51,6 @@ FAQ
 ::
 
     # Luna 打开网页提示403 Forbidden错误，一般是nginx配置文件的luna路径不正确或者luna下载了源代码，请重新下载编译好的代码
-
     # Luna 打开网页提示502 Bad Gateway错误，一般是selinux和防火墙的问题，请根据nginx的errorlog来检查
 
 4. 录像问题
@@ -134,9 +133,16 @@ FAQ
 
     $ vim /opt/jumpserver/apps/jumpserver/settings.py
 
-    # 找到如下行，注释（可参考 django 设置 session 过期时间），修改或者新增你要的设置即可
+    # 找到如下行，注释（可参考 django 设置 session 过期时间），修改你要的设置即可
     # SESSION_COOKIE_AGE = CONFIG.SESSION_COOKIE_AGE or 3600 * 24
 
     # 如下，设置关闭浏览器 cookie 失效，则修改为
     # SESSION_COOKIE_AGE = CONFIG.SESSION_COOKIE_AGE or 3600 * 24
     SESSION_EXPIRE_AT_BROWSER_CLOSE = True
+
+10. MFA遗失无法登陆
+
+::
+
+    # 普通用户联系管理员关闭MFA，登录成功后用户在个人信息里面重新绑定.
+    # 如果管理员遗失无法登陆, 修改user_user表对应用户的otp_level为0, 重新登陆绑定即可

docs/faq_googleauth.rst

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