Merge remote-tracking branch 'github/docs' into 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

@@ -5,11 +5,11 @@ FAQ
 
 ::
 
-    (1). 如果白屏  可能是nginx配置文件的guacamole设置的不对，也可能运行guacamole的docker容器有问题，总之请求到不了guacamole
-    (2). 如果显示没有权限 可能是你在 终端管理里没有接受 guacamole的注册，请接受一下，如果还是不行，就删除刚才的注册，重启guacamole的docker重新注册
+    (1). 如果白屏  检查nginx配置文件的guacamole设置ip是否正确，检查终端管理的gua状态是否在线，检查资产设置及系统用户是否正确；
+    (2). 如果显示没有权限 可能是你在 终端管理里没有接受 guacamole的注册，请接受一下，然后重启guacamole
     (3). 如果显示未知问题 可能是你的资产填写的端口不对，或者授权的系统用户的协议不是rdp
-    (4). 提示无法连接服务器，请联系管理员或查看日志 一般情况下是登录的系统账户不正确，可以从Windows的日志查看信息
-    (5). 提示网络问题无法连接或者超时，请检查网络连接并重试，或联系管理员 一般情况下是防火墙设置不正确，可以从Windows的日志查看信息
+    (4). 提示无法连接服务器，请联系管理员或查看日志 一般情况下是登录的系统账户不正确，可以从Windows的日志查看信息（资产的信息填写不正确也会报这个错误）
+    (5). 提示网络问题无法连接或者超时，请检查网络连接并重试，或联系管理员 一般情况下是防火墙设置不正确，可以从Windows的日志查看信息（资产的信息填写不正确也会报这个错误）
 
 2. Linux 资产连接错误排查思路
 
@@ -33,26 +33,34 @@ FAQ
     Sudo: /usr/bin/git,/usr/bin/php,/bin/cat,/bin/more,/bin/less,/usr/bin/head,/usr/bin/tail
     意思是允许这个系统用户免密码执行 git、PHP、cat、more、less、head、tail 命令，只要关联了这个系统用户的用户在相应的资产都可以执行这些命令。
 
-4. coco或guacamole 注册失败，或重新注册方法
+4. coco或guacamole注册失败，或重新注册方法
 
 ::
 
-    (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报错汇总
 
@@ -113,8 +121,25 @@ FAQ
 
     (3). Failed to connect to the host via ssh: ssh_exchange_identification: read: Connection reset by peer\r\n
 
-        # 一般是资产的 ssh 或者 防火墙 做了限制
+        # 一般是资产的 ssh 或者 防火墙 做了限制，无法连接资产（资产信息填错也可能会报这个错误）
 
     (4). "MODULE FAILURE","module_stdout":"/bin/sh: 1: /usr/bin/python: not found\r\n","module_stderr":"Shared connection to xx.xx.xx.xx closed.\r\n"
 
-        # 一般是资产 python 未安装或者 python 异常，此问题多发生在 ubuntu 资产上
+        # 一般是资产 python 未安装或者 python 异常
+
+9. 其他问题
+
+::
+
+    (1). 邮箱设置 新建用户无法收到邮件需要重启一次jumpserver（系统设置修改需要重启的问题后面会修正）
+
+    (2). 收到的邮件链接地址是 localhost 可以到 系统设置-基本设置 里面修改url，保存后重启即可
+
+    (3). coco 提示[service ERROR] Failed register terminal jzsas exist already
+        # 参考上面的coco重新注册方法
+
+    (4). guacamole 不在线
+        # 尝试重启一下guacamole，然后再看看，如果任然不在线，参考上面gua重新注册的方法
+        $ docker restart jms_guacamole  # 如果容器的名称不对，请用docker ps查询
+
+    (5). LDAP设置 测试通过，但是登录失败需要检查用户的ou是否正确，如果使用用户cn作为登录用户名，请确认用户的cn属性不是中文

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]开头的一个注册，如果页面显示不正常可以等部署完成后再处理
 
 
 
@@ -281,8 +277,7 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
         }
 
         location /guacamole/ {
-            proxy_pass       http://localhost:8081/;
-            ## 请手动修改 localhost:8081 为运行 docker 服务的服务器地址, windows资产连接白屏的问题多数是出现在这里
+            proxy_pass       http://localhost:8081/;  # 如果guacamole安装在别的服务器，请填写它的ip
             proxy_buffering off;
             proxy_http_version 1.1;
             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -306,11 +301,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
 
@@ -284,7 +280,7 @@ Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/term
     $ yum -y install nginx
 
 
-6.2 准备配置文件 修改 /etc/nginx/conf.d/jumpserver.conf
+6.2 准备配置文件 修改 /etc/nginx/nginx.conf
 
 内容如下：
 
@@ -325,7 +321,7 @@ Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/term
         }
 
         location /guacamole/ {
-            proxy_pass       http://localhost:8081/;  # 请修改成运行docker服务的服务器IP，windows资产连接白屏的问题多数是出现在这里
+            proxy_pass       http://localhost:8081/;  # 如果guacamole安装在别的服务器，请填写它的ip
             proxy_buffering off;
             proxy_http_version 1.1;
             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -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
+    
+    # 1.0.x 升级 1.2.0 需要执行迁移脚本（新版本授权管理更新）
+    $ sh 2018_04_11_migrate_permissions.sh
+ 
+2. 升级 Coco（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
 
 ::
 
@@ -23,7 +26,8 @@
 
     $ docker pull registry.jumpserver.org/public/guacamole:latest
     $ docker stop jms_guacamole  # 或者写guacamole的容器ID
-    $ docker run --name jms_guacamole -d \
+    $ docker rename jms_guacamole jms_guacamole_bak  # 如果名称不正确请手动修改
+    $ 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://<填写本机的IP地址>:8080 \
@@ -36,7 +40,7 @@
 
 **Jumpserver**
 
-说明: 以下操作，都在jumpserver所在目录运行
+说明: 以下操作，都在jumpserver所在目录运行（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
 
 1. 备份配置文件
 
@@ -115,7 +119,7 @@ coco是无状态的，备份 keys 目录即可
    $ cp -r keys $jumpserver_backup/
 
 
-2. 离线更新升级coco
+2. 离线更新升级coco（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
 
 3. 还原 keys目录