Merge pull request #1177 from wojiushixiaobai/docs

更新文档

docs/admin_create_asset.rst

@@ -45,7 +45,7 @@
 
 点击邮件中的设置密码链接，设置好密码后，您就可以用户名和密码登录 Jumpserver 了。
 
-用户首次登录 Jumpserver，会被要求完善用户信息。基本信息可以不变，但 SSH 密钥信息必须填上。
+用户首次登录 Jumpserver，会被要求完善用户信息。
 
 Linux/Unix 生成 SSH 密钥可以参考（https://www.cnblogs.com/horanly/p/6604104.html)
 

docs/faq.rst

@@ -37,22 +37,30 @@ FAQ
 
 ::
 
-    (1). 停止 coco 或 删掉 guacamole 的docker
+    (1). 在 Jumpserver后台 会话管理 - 终端管理  删掉它们
 
-      $ cd /opt/coco && ./cocod stop
-
-      $ 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>
-
-      # 可以使用docker --help 查询用法
+    (2). coco 重新注册（注意虚拟环境 source /opt/py3/bin/activate）
 
-   (2). 在 Jumpserver后台 会话管理 - 终端管理  删掉它们
+      $ cd /opt/coco && ./cocod stop
+      $ rm /opt/coco/keys/.access_key  # coco, 如果你是按文档安装的，key应该在这里
+      $ ./cocod start -d  # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册
 
-   (3). 删掉它们曾经注册的key
+   (3). guacamole重新注册
 
-      $ rm /opt/coco/keys/.access_key  # coco, 如果你是按文档安装的，key应该在这里
       $ rm /opt/guacamole/key/*  # guacamole, 如果你是按文档安装的，key应该在这里
-
+      $ 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/*
+      $ systemctl stop docker
+      $ systemctl start docker
+      $ docker run —name jms_guacamole -d \
+         -p 8081:8080 -v /opt/guacamole/key:/config/guacamole/key \
+         -e JUMPSERVER_KEY_DIR=/config/guacamole/key \
+         -e JUMPSERVER_SERVER=http://<填写jumpserver的IP地址>:8080 \
+         registry.jumpserver.org/public/guacamole:1.0.0
+
+      # 正常运行后到Jumpserver 会话管理-终端管理 里面接受gua注册
+      $ docker restart jms_guacamole  # 如果接受注册后显示不在线，重启gua就好了
 
 5. Ansible报错汇总
 

docs/setup_by_ubuntu.rst

@@ -140,7 +140,7 @@
 
     # 新版本更新了运行脚本，使用方式./jms start|stop|status|restart all  后台运行请添加 -d 参数
 
-运行不报错，请浏览器访问 http://192.168.244.144:8080/ 页面显示不正常先不用处理，继续往下操作
+运行不报错，请浏览器访问 http://192.168.244.144:8080/ 默认账号: admin 密码: admin 页面显示不正常先不用处理，继续往下操作
 
 三. 安装 SSH Server 和 WebSocket Server: Coco
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -173,11 +173,7 @@
 
     # 新版本更新了运行脚本，使用方式./cocod start|stop|status|restart 后台运行请添加 -d 参数
 
-::
-
-    Coco version 1.0.0, more see https://www.jumpserver.org
-    Starting ssh server at 0.0.0.0:2222
-    Quit the server with CONTROL-C.
+启动成功后去Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/terminal/）接受coco的注册，如果页面显示不正常可以等部署完成后再处理
 
 四. 安装 Web Terminal 前端: Luna
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -227,8 +223,8 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
 
 这里所需要注意的是 guacamole 暴露出来的端口是 8081，若与主机上其他端口冲突请自定义一下。
 
-再次强调：修改 JUMPSERVER_SERVER 环境变量的配置，填上 Jumpserver 的内网地址, 不能使用 localhost 和 127.0.0.1, 这时
-去 Jumpserver-会话管理-终端管理 接受[Gua]开头的一个注册
+再次强调：修改 JUMPSERVER_SERVER 环境变量的配置，填上 Jumpserver 的内网地址, 启动成功后
+去 Jumpserver-会话管理-终端管理 接受[Gua]开头的一个注册，如果页面显示不正常可以等部署完成后再处理
 
 
 
@@ -306,11 +302,27 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
     $ service nginx restart
 
 
-6.4 访问 http://192.168.244.144
+6.4 开始使用 Jumpserver
+
+检查应用是否已经正常运行
+
+::
+
+    # 如果是新开的终端，别忘了 source /opt/py3/bin/activate
+    $ cd /opt/jumpserver
+    $ ./jms status  # 确定jumpserver已经运行，如果没有运行请重新启动jumpserver
+
+    $ cd /opt/coco
+    $ ./cocod status  # 确定jumpserver已经运行，如果没有运行请重新启动coco
+
+    # 如果安装了 Guacamole
+    $ docker ps  # 检查容器是否已经正常运行，如果没有运行请重新启动Guacamole
+
+服务全部启动后，访问 http://192.168.244.144
 
 默认账号: admin 密码: admin
 
-到会话管理-终端管理 接受 Coco Guacamole 等应用的注册
+如果部署过程中没有接受应用的注册，需要到Jumpserver 会话管理-终端管理 接受 Coco Guacamole 等应用的注册
 
 ** 测试连接**
 

docs/step_by_step.rst

@@ -168,7 +168,7 @@ Pip 加速设置请参考 <https://segmentfault.com/a/1190000011875306>
 
     # 新版本更新了运行脚本，使用方式./jms start|stop|status|restart all  后台运行请添加 -d 参数
 
-运行不报错，请浏览器访问 http://192.168.244.144:8080/  页面显示不正常先不用处理，搭建 nginx 代理就可以正常访问了
+运行不报错，请浏览器访问 http://192.168.244.144:8080/  默认账号: admin 密码: admin 页面显示不正常先不用处理，搭建 nginx 代理就可以正常访问了
 
 附上重启的方法
 
@@ -208,11 +208,7 @@ Pip 加速设置请参考 <https://segmentfault.com/a/1190000011875306>
 
     # 新版本更新了运行脚本，使用方式./cocod start|stop|status|restart  后台运行请添加 -d 参数
 
-::
-
-    Coco version 1.0.0, more see https://www.jumpserver.org
-    Starting ssh server at 0.0.0.0:2222
-    Quit the server with CONTROL-C.
+启动成功后去Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/terminal/）接受coco的注册，如果页面不正常可以等部署完成后再处理
 
 四. 安装 Web Terminal 前端: Luna
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -261,7 +257,7 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
 这里所需要注意的是 guacamole 暴露出来的端口是 8081，若与主机上其他端口冲突请自定义
 
 修改 JUMPSERVER_SERVER 环境变量的配置，填上 Jumpserver 的内网地址, 启动成功后去
-Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/terminal/）接受[Gua]开头的一个注册
+Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/terminal/）接受[Gua]开头的一个注册，如果页面显示不正常可以等部署完成后再处理
 
 .. code:: shell
 
@@ -356,13 +352,27 @@ Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/term
     $ service nginx start
     $ chkconfig nginx on
 
+6.4 开始使用 Jumpserver
+
+检查应用是否已经正常运行
+
+::
+
+    # 如果是新开的终端，别忘了 source /opt/py3/bin/activate
+    $ cd /opt/jumpserver
+    $ ./jms status  # 确定jumpserver已经运行，如果没有运行请重新启动jumpserver
+
+    $ cd /opt/coco
+    $ ./cocod status  # 确定jumpserver已经运行，如果没有运行请重新启动coco
 
+    # 如果安装了 Guacamole
+    $ docker ps  # 检查容器是否已经正常运行，如果没有运行请重新启动Guacamole
 
-6.4 访问 http://192.168.244.144
+服务全部启动后，访问 http://192.168.244.144
 
 默认账号: admin 密码: admin
 
-到会话管理-终端管理 接受 Coco Guacamole 等应用的注册
+如果部署过程中没有接受应用的注册，需要到Jumpserver 会话管理-终端管理 接受 Coco Guacamole 等应用的注册。
 
 ** 测试连接**
 

docs/upgrade.rst

 更新升级
 -------------
 
-1. 升级 Jumpserver
+1. 升级 Jumpserver（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
 
 ::
 
     $ git pull && pip install -r requirements/requirements.txt && cd utils && sh make_migrations.sh
 
-2. 升级 Coco
+2. 升级 Coco（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
 
 ::
 
@@ -36,7 +36,7 @@
 
 **Jumpserver**
 
-说明: 以下操作，都在jumpserver所在目录运行
+说明: 以下操作，都在jumpserver所在目录运行（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
 
 1. 备份配置文件
 
@@ -115,7 +115,7 @@ coco是无状态的，备份 keys 目录即可
    $ cp -r keys $jumpserver_backup/
 
 
-2. 离线更新升级coco
+2. 离线更新升级coco（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
 
 3. 还原 keys目录