Merge pull request #1302 from wojiushixiaobai/docs

更新文档

docs/faq.rst

@@ -209,3 +209,11 @@ FAQ
         > select * from django_migrations;
         # 如果对比结果不一样则无法升级
         > quit;
+
+    (14). 设置浏览器过期
+        $ vim /opt/jumpserver/apps/jumpserver/settings.py
+
+        # 找到如下行，注释（可参考 django 设置 session 过期时间）
+        # SESSION_COOKIE_AGE = CONFIG.SESSION_COOKIE_AGE or 3600 * 24
+        # 如下，设置关闭浏览器 cookie 失效
+        # SESSION_EXPIRE_AT_BROWSER_CLOSE = True

docs/faq_windows.rst

 Windows 资产连接说明
 ----------------------------
 
-1. 检查终端是否在线（如果不在线，参考FAQ文档进行处理）
+1. 检查终端是否在线
+
+::
+
+    # 如果不在线请检查 Windows 组件是否已经正常运行
+    $ docker ps
+
+    # 如果已经正常运行，但是终端没有 guacamole 的注册请求
+    $ systemctl status firewalld  # 检查防火墙是否运行，如果防火墙运行请开放 guacamole 端口
+
+    # 如果之前删除过 guacamole 容器，请检查 key 是否已经删除
+    $ rm -rf /opt/guacamole/key/*  # 默认在这里
+
+    # 如果未安装 guacamole 请参照安装文档的 windows 组件部分进行处理
 
 .. image:: _static/img/faq_windows_01.jpg
 
 2. 登录要连接的windows资产，检查用户和IP信息（Windows目前还不支持推送，所以必须使用资产上面已存在的用户进行登录）
 
+::
+
+    # 注：因为 windows 暂时不支持推送，所以必须使用资产上面已经存在的账户进行登录，如 administrator 账户
+    $ net user  # 在 windows 资产上用此命令查询已有用户
+
 .. image:: _static/img/faq_windows_02.jpg
 
 3. 创建Windows资产管理用户（如果是域资产，格式是uesr@domain.com）
 
+::
+
+    # 不带域的用户直接输入用户名即可，如 administrator
+    # 域用户的用户名格式为 user@domain.com，如 administrator@jumpserver.org
+
 .. image:: _static/img/faq_windows_03.jpg
 
 4. 创建Windows资产系统用户（如果是域资产，格式是uesr@domain.com，注意协议不要选错）
 
+::
+
+    # 不带域的用户直接输入用户名即可，如 administrator
+    # 域用户的用户名格式为 user@domain.com，如 administrator@jumpserver.org
+
 .. image:: _static/img/faq_windows_04.jpg
 
 5. 创建Windows资产（注意端口不要填错）
@@ -23,6 +51,10 @@ Windows 资产连接说明
 
 6. 创建授权规则
 
+::
+
+    # 先定位到 windows 的资产，然后授权，如果资产用户密码不一致，请不要直接在节点上授权
+
 .. image:: _static/img/faq_windows_06.jpg
 
 7. 使用web terminal登录（如果登录报错，检查防火墙的设置，可以参考FAQ）

docs/quickinstall.rst

@@ -3,13 +3,20 @@
 
 因为懒，所以更专业。
 
-组件解释
+组件说明
 ~~~~~~~~~~~~~~
 - Jumpserver 为管理后台，管理员可以通过Web页面进行资产管理、用户管理、资产授权等操作
-- Coco 为 SSH Server 和 Web Terminal Server 。用户可以通过使用自己的账户登录 SSH 或者 Web Terminal 直接访问被授权资产。不需要知道服务器的账户密码
+- Coco 为 SSH Server 和 Web Terminal Server 。用户可以通过使用自己的账户登录 SSH 或者 Web Terminal 直接访问被授权的资产。不需要知道服务器的账户密码
 - Luna 为 Web Terminal Server 前端页面，用户使用 Web Terminal 方式登录所需要的组件
 - Guacamole 为 Windows 组件，用户可以通过 Web Terminal 来连接 Windows 资产 （暂时只能通过 Web Terminal 来访问）
 
+端口说明
+~~~~~~~~~~~~~~
+- Jumpserver 默认端口为 8080/tcp 配置文件在 jumpserver/config.py
+- Coco 默认 SSH 端口为 2222/tcp ，默认 Web Terminal 端口为 5000/tcp 配置文件在 coco/conf.py
+- Guacamole 默认端口为 8081/tcp 在 docker run 时指定
+- Nginx 默认端口为 80/tcp
+
 安装文档
 ~~~~~~~~~~~~~~
 

docs/setup_by_centos7.rst

@@ -233,8 +233,9 @@ CentOS 7 安装文档
 
     # 安装 Web Terminal 前端: Luna  需要 Nginx 来运行访问 访问（https://github.com/jumpserver/luna/releases）下载对应版本的 release 包，直接解压，不需要编译
     $ cd /opt
-    $ wget https://github.com/jumpserver/luna/releases/download/v1.0.0/luna.tar.gz
-    $ tar xvf luna.tar.gz
+    $ wget https://github.com/jumpserver/luna/releases/download/1.3.0/dist.tar.gz
+    $ tar xvf dist.tar.gz
+    $ mv dist luna
 
     # 安装 Windows 支持组件（如果不需要管理 windows 资产，可以直接跳过这一步）
     $ yum remove docker-latest-logrotate  docker-logrotate  docker-selinux dockdocker-engine

docs/setup_by_ubuntu.rst

@@ -203,9 +203,10 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
 
 ::
 
-    $ /opt/
-    $ wget https://github.com/jumpserver/luna/releases/download/v1.0.0/luna.tar.gz
-    $ tar xvf luna.tar.gz
+    $ cd /opt/
+    $ wget https://github.com/jumpserver/luna/releases/download/1.3.0/dist.tar.gz
+    $ tar xvf dist.tar.gz
+    $ mv dist luna
     $ chown -R root:root luna/
     $ ls /opt/luna
     ...
@@ -233,7 +234,7 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
     $ apt-get update
     $ apt-get install docker-ce
 
-    # 注意：这里一定要改写一下本机的IP地址, 否则会出错，带宽有限, 下载时间可能有点长，可以喝杯咖啡，别看对面了，你对面不是小姐姐。
+    # 注意：这里一定要改下面命令的 jumpserver url 地址
 
     $ docker run --name jms_guacamole -d \
       -p 8081:8080 -v /opt/guacamole/key:/config/guacamole/key \

docs/step_by_step.rst

@@ -241,8 +241,9 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
     $ pwd
     /opt/
 
-    $ wget https://github.com/jumpserver/luna/releases/download/v1.0.0/luna.tar.gz
-    $ tar xvf luna.tar.gz
+    $ wget https://github.com/jumpserver/luna/releases/download/1.3.0/dist.tar.gz
+    $ tar xvf dist.tar.gz
+    $ mv dist luna
     $ ls /opt/luna
     ...
 
@@ -277,7 +278,7 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
 
 这里所需要注意的是 guacamole 暴露出来的端口是 8081，若与主机上其他端口冲突请自定义
 
-修改 JUMPSERVER_SERVER 环境变量的配置，填上 Jumpserver 的内网地址, 启动成功后去
+修改下面 docker run 里的 JUMPSERVER_SERVER 参数，填上 Jumpserver 的 url 地址, 启动成功后去
 Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/terminal/）接受[Gua]开头的一个注册，如果页面显示不正常可以等部署完成后再处理
 
 .. code:: shell
@@ -289,7 +290,7 @@ Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/term
       -p 8081:8080 -v /opt/guacamole/key:/config/guacamole/key \
       -e JUMPSERVER_KEY_DIR=/config/guacamole/key \
       -e JUMPSERVER_SERVER=http://<填写jumpserver的url地址> \
-      registry.jumpserver.org/public/guacamole:1.0.0
+      registry.jumpserver.org/public/guacamole:latest
 
 六. 配置 Nginx 整合各组件
 ~~~~~~~~~~~~~~~~~~~~~~~~~

docs/upgrade.rst

@@ -5,7 +5,10 @@
 
 ::
 
-    $ git pull && pip install -r requirements/requirements.txt && cd utils && sh make_migrations.sh
+    # 新版本更新了自动升级脚本，升级只需要到 utils 目录下执行 sh upgrade.sh 即可
+    $ git pull
+    $ pip install -r requirements/requirements.txt  # 如果使用其他源下载失败可以使用 -i 参数指定源
+    $ cd utils && sh make_migrations.sh
 
     # 1.0.x 升级 1.2.0 需要执行迁移脚本（新版本授权管理更新）
     $ sh 2018_04_11_migrate_permissions.sh
@@ -14,16 +17,22 @@
 
 ::
 
-
+    # 新版本更新了自动升级脚本，升级只需要到 utils 目录下执行 sh upgrade.sh 即可
     $ git pull && pip install -r requirements/requirements.txt
 
     # 如果使用其他源下载失败可以使用 -i 参数指定源
-    $ git pull && pip install -r requirements/requirements.txt -i https://pypi.org/simple
+    $ pip install -r requirements/requirements.txt -i https://pypi.org/simple
 
 3. 升级 Luna
 
 重新下载 release 包（https://github.com/jumpserver/luna/releases）
 
+::
+
+    $ wget https://github.com/jumpserver/luna/releases/download/1.3.0/dist.tar.gz
+    $ tar xvf dist.tar.gz
+    $ mv dist luna
+
 4. 升级 guacamole
 
 ::
@@ -62,12 +71,14 @@
 
 ::
 
+
   $ mysqldump -u你的数据库账号 -h数据库地址 -p 数据库名称 > $jumpserver_backup/db_backup.sql
 
 3. 切换分支或下载离线包, 更新代码
 
 ::
 
+
    $ cd /opt
    $ mv jumpserver jumpserver_bak
    $ git clone https://github.com/jumpserver/jumpserver.git
@@ -78,6 +89,7 @@
 
 ::
 
+
    $ cp -r $jumpserver_backup/media/* data/media/
 
 5. 更新依赖或表结构