Merge pull request #2384 from wojiushixiaobai/docs

Docs

docs/dockerinstall.rst

@@ -61,8 +61,6 @@ XShell等工具请添加 connection 连接, 默认 ssh 端口 2222
 - REDIS_PASSWORD =
 
 - VOLUME /opt/jumpserver/data
-- VOLUME /opt/coco/keys
-- VOLUME /config/guacamole/keys
 - VOLUME /var/lib/mysql
 
 .. code-block:: shell

docs/faq.rst

@@ -85,8 +85,8 @@ FAQ
 
     $ vi /opt/coco/config.yml
 
-    # 把 SSH_TIMEOUT = 15 修改成你想要的数字 单位为：秒
-    SSH_TIMEOUT = 60
+    # 把 SSH_TIMEOUT: 15 修改成你想要的数字 单位为：秒
+    SSH_TIMEOUT: 60
 
 7. 设置浏览器过期
 
@@ -94,15 +94,15 @@ FAQ
 
     $ vi /opt/jumpserver/config.yml
 
-.. code-block:: python
+.. code-block:: yaml
 
     # 找到如下行(可参考 django 设置 session 过期时间),修改你要的设置即可
-    # SESSION_COOKIE_AGE = 3600 * 24
-    # SESSION_EXPIRE_AT_BROWSER_CLOSE = False
+    # SESSION_COOKIE_AGE: 3600 * 24
+    # SESSION_EXPIRE_AT_BROWSER_CLOSE: False
 
     # 如下,设置关闭浏览器 cookie 失效,则修改为
-    # SESSION_COOKIE_AGE = 3600 * 24
-    SESSION_EXPIRE_AT_BROWSER_CLOSE = True
+    # SESSION_COOKIE_AGE: 3600 * 24
+    SESSION_EXPIRE_AT_BROWSER_CLOSE: True
 
 8. 资产授权说明
 

docs/faq_install.rst

@@ -91,7 +91,7 @@
 
 .. code-block:: vim
 
-    # 这是因为你在 config.yml 里面设置了 DEBUG = False
+    # 这是因为你在 config.yml 里面设置了 DEBUG: false
     # 跟着教程继续操作,后面搭建 nginx 代理即可正常访问
 
 13. 执行 ./cocod start 后提示 No module named 'jms'
@@ -118,7 +118,7 @@
     # 必须到 Jumpserver后台 会话管理-终端管理  删掉 coco 的注册
     # 一定要先到 Jumpserver后台 会话管理-终端管理  删掉 coco 的注册
     $ cd /opt/coco && ./cocod stop
-    $ rm /opt/coco/keys/.access_key  # coco, 如果你是按文档安装的,key应该在这里,如果不存在key文件直接下一步
+    $ rm /opt/coco/data/keys/.access_key  # coco, 如果你是按文档安装的,key应该在这里,如果不存在key文件直接下一步
     $ ./cocod start -d  # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册
 
 15. 执行 ./cocod start 后提示 Failed register terminal unknow: xxxx
@@ -130,8 +130,8 @@
     $ vi config.yml
 
     # 项目名称, 会用来向Jumpserver注册, 识别而已, 不能重复
-    # NAME = "localhost"
-    NAME = "coco"
+    # NAME: {{ Hostname }}
+    NAME: localhost
 
     保存后重新执行 ./cocod start 即可
 

docs/faq_ssh.rst

@@ -26,7 +26,7 @@ SSH 协议资产连接错误排查思路
 
     # 正常部署请参照此步骤解决
     $ cd /opt/coco && ./cocod stop
-    $ rm /opt/coco/keys/.access_key  # coco, 如果你是按文档安装的,key应该在这里,如果不存在,直接下一步
+    $ rm /opt/coco/data/keys/.access_key  # coco, 如果你是按文档安装的,key应该在这里,如果不存在,直接下一步
     $ ./cocod start -d
 
     # docker 部署请直接删除容器后重建,记得一定要先在 终端管理 删除不在线的组件
@@ -84,8 +84,8 @@ SSH 协议资产连接错误排查思路
     $ vi config.yml
 
     # 项目名称, 会用来向Jumpserver注册, 识别而已, 不能重复
-    # NAME = "localhost"
-    NAME = "localhost"
+    # NAME: {{ Hostname }}
+    NAME: localhost
 
 7. 测试可连接性 及 更新硬件信息
 

docs/faq_upgrade.rst

@@ -59,8 +59,8 @@
     > quit
 
     # 修改配置文件
-    $ cp /opt/jumpserver_bak/config.yml /opt/jumpserver/
-    $ vim /opt/jumpserver/config.yml
+    $ cp /opt/jumpserver_bak/config.py /opt/jumpserver/
+    $ vim /opt/jumpserver/config.py
     DB_ENGINE = 'mysql'
     DB_HOST = '127.0.0.1'
     DB_PORT = 3306

docs/upgrade.rst

@@ -271,7 +271,8 @@
 .. code-block:: vim
 
     # SECURITY WARNING: keep the secret key used in production secret!
-    # 加密秘钥 生产环境中请修改为随机字符串，请勿外泄
+    # 加密秘钥 生产环境中请修改为随机字符串，请勿外泄, 可使用命令生成
+    # $ cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 49;echo
     SECRET_KEY: *****
 
     # SECURITY WARNING: keep the bootstrap token used in production secret!