Merge pull request #1960 from wojiushixiaobai/docs

[Update]Docs

docs/admin_create_asset.rst

@@ -10,7 +10,7 @@
 一、系统设置
 ````````````````````
 
-1.1 基本设置
+**1.1 基本设置**
 
 ::
 
@@ -19,7 +19,7 @@
 
 .. image:: _static/img/basic_setting.jpg
 
-1.2 邮件设置
+**1.2 邮件设置**
 
 ::
 
@@ -30,7 +30,7 @@
 
 .. image:: _static/img/smtp_setting.jpg
 
-1.3 LDAP设置
+**1.3 LDAP设置**
 
 ::
 
@@ -40,7 +40,7 @@
     注：可借用第三方 gui 工具查看 ldap 用户的属性，新版本已经支持中文名登录，即cn=中文也可正常使用
     详细设置请参考`LDAP 使用说明 <faq_ldap.html>`_
 
-1.4 终端设置
+**1.4 终端设置**
 
 ::
 
@@ -52,12 +52,12 @@
 
     修改后，需要修改在Jumpserver 会话管理-终端管理 修改terminal的配置 录像存储 命令记录，然后重启 Jumpserver 服务
 
-1.5 安全设置
+**1.5 安全设置**
 
 二、创建用户
 `````````````````````
 
-2.1 创建 Jumpserver 用户
+**2.1 创建 Jumpserver 用户**
 
 ::
 
@@ -74,9 +74,9 @@
 三、创建资产
 ``````````````````
 
-3.1 创建 Linux 资产
+**3.1 创建 Linux 资产**
 
-3.1.1 编辑资产树
+**3.1.1 编辑资产树**
 
 ::
 
@@ -85,7 +85,7 @@
 
 .. image:: _static/img/asset_tree.jpg
 
-3.1.2 创建管理用户
+**3.1.2 创建管理用户**
 
 ::
 
@@ -121,7 +121,7 @@
 
 .. image:: _static/img/create_asset_admin_user.jpg
 
-3.1.3 创建系统用户
+**3.1.3 创建系统用户**
 
 ::
 
@@ -152,7 +152,7 @@
 
 .. image:: _static/img/create_asset_system_user.jpg
 
-3.1.4 创建资产
+**3.1.4 创建资产**
 
 ::
 
@@ -174,35 +174,9 @@
 
 参考 `Linux 资产连接说明 <faq_linux.html>`_
 
-3.1.5 网域列表
+**3.2 创建 Windows 资产**
 
-::
-
-    # 网域功能是为了解决部分环境无法直接连接而新增的功能，原理是通过网关服务器进行跳转登录
-    # 点击页面左侧的“网域列表”按钮，查看所有网域列表
-    # 点击页面左上角的“创建网域”按钮，进入网域创建页面，选择资产里用作网域的网关服务器
-    注：混合云适用
-
-.. image:: _static/img/create_domain.jpg
-
-::
-
-    # 点击网域的名称，进入网域详情列表。
-    # 点击页面的“网关”按钮，选择网关列表的“创建网关”按钮，进入网关创建页面，填写网关信息。
-    # IP信息一般默认填写网域资产的IP即可（如用作网域的资产有多块网卡和IP地址，选能与jumpserer通信的任一IP即可）
-    注：用户名与密码可以使用网关资产上已存在的任一拥有执行 ssh 命令权限的用户
-
-.. image:: _static/img/create_geteway.jpg
-
-::
-
-    注：保存信息后点击测试连接，确定设置无误后到资产列表添加需要使用网关登录的资产即可。
-
-.. image:: _static/img/create_asset02.jpg
-
-3.2 创建 Windows 资产
-
-3.2.1 创建 Windows 系统管理用户
+**3.2.1 创建 Windows 系统管理用户**
 
 ::
 
@@ -210,7 +184,7 @@
 
 .. image:: _static/img/create_windows_admin.jpg
 
-3.2.2 创建 Windows 系统系统用户
+**3.2.2 创建 Windows 系统系统用户**
 
 ::
 
@@ -221,7 +195,7 @@
 
 .. image:: _static/img/create_windows_user.jpg
 
-3.2.3 创建 Windows 资产
+**3.2.3 创建 Windows 资产**
 
 ::
 
@@ -234,10 +208,39 @@
 
 参考 `Windows 资产连接说明 <faq_windows.html>`_
 
-四、资产节点管理
+四、 网域网关
 ``````````````````````
 
-4.1 为资产树节点分配资产
+**4.1 网域列表**
+
+::
+
+    # 网域功能是为了解决部分环境无法直接连接而新增的功能，原理是通过网关服务器进行跳转登录
+    # 点击页面左侧的“网域列表”按钮，查看所有网域列表
+    # 点击页面左上角的“创建网域”按钮，进入网域创建页面，选择资产里用作网域的网关服务器
+    注：混合云适用
+
+.. image:: _static/img/create_domain.jpg
+
+::
+
+    # 点击网域的名称，进入网域详情列表。
+    # 点击页面的“网关”按钮，选择网关列表的“创建网关”按钮，进入网关创建页面，填写网关信息。
+    # IP信息一般默认填写网域资产的IP即可（如用作网域的资产有多块网卡和IP地址，选能与jumpserer通信的任一IP即可）
+    注：用户名与密码可以使用网关资产上已存在的任一拥有执行 ssh 命令权限的用户
+
+.. image:: _static/img/create_geteway.jpg
+
+::
+
+    注：保存信息后点击测试连接，确定设置无误后到资产列表添加需要使用网关登录的资产即可。
+
+.. image:: _static/img/create_asset02.jpg
+
+五、资产节点管理
+``````````````````````
+
+**5.1 为资产树节点分配资产**
 
 ::
 
@@ -251,7 +254,7 @@
 
 .. image:: _static/img/select_asset_to_node.jpg
 
-4.2 删除节点资产
+**5.2 删除节点资产**
 
 ::
 
@@ -259,9 +262,11 @@
 
 .. image:: _static/img/delete_asset_from_node.jpg
 
-五、创建授权规则
+六、创建授权规则
 `````````````````````
 
+**6.1 为用户分配资产**
+
 ::
 
     # 名称，授权的名称，不能重复
@@ -289,10 +294,10 @@
     # 职责不同，权限就不同，按照职责制定系统用户
     # 这样授权就不会乱
 
-六、用户使用资产
+七、用户使用资产
 `````````````````````
 
-6.1 登录 Jumpserver
+**7.1 登录 Jumpserver**
 
 ::
 
@@ -300,9 +305,9 @@
 
 .. image:: _static/img/user_login_success.jpg
 
-6.2 使用资产
+**7.2 使用资产**
 
-6.2.1 连接资产
+**7.2.1 连接资产**
 
 ::
 
@@ -323,7 +328,7 @@
 
 .. image:: _static/img/windows_assert.jpg
 
-6.2.2 断开资产
+**7.2.2 断开资产**
 
 ::
 

docs/contributor.rst

@@ -10,7 +10,7 @@
 - **yumaojun03 <喻茂峻>** DevOps 资深开发者，擅长 Python、Go 以及 PaaS 平台开发
 - **kelianchun <柯连春>** DevOps 资产开发者，修复了很多 Bugs
 - **小彧 <李磊>** Django 资深开发者，为用户模块贡献了很多代码
-- **sofia <周小侠>** 资深前端工程师, 前端代码贡献者 
+- **sofia <周小侠>** 资深前端工程师, 前端代码贡献者
 - **q4speed <莫鹍>** 架构师，贡献了 Windows 远程桌面登录大部分代码
 - **ZhangFengyi <张峰毅>** 贡献了 新版文档
 - **Aaron3S <沈晨阳>** 贡献了 新版文档

docs/dockerinstall.rst

@@ -3,6 +3,10 @@ Docker 安装
 
 Jumpserver 封装了一个 All in one Docker，可以快速启动。该镜像集成了所需要的组件，支持使用外置 Database 和 Redis
 
+Tips: 不建议在生产中使用, 因为所有软件都打包到一个Docker中了，不是Docker最佳实践,
+生产中请使用 详细安装 `CentOS <step_by_step.rst>`_  `Ubuntu <setup_by_ubuntu.rst>`_
+Docker 安装见: `Docker官方安装文档 <https://docs.docker.com/install/>`_
+
 数据库要求
 ```````````````
 - mysql 版本需要大于等于 5.6
@@ -10,10 +14,6 @@ Jumpserver 封装了一个 All in one Docker，可以快速启动。该镜像集
 - PostgreSQL 版本需要大于等于 9.4
 - 数据库编码要求 uft8
 
-Tips: 不建议在生产中使用, 因为所有软件都打包到一个Docker中了，不是Docker最佳实践,
-生产中请使用 详细安装 `CentOS <step_by_step.rst>`_  `Ubuntu <setup_by_ubuntu.rst>`_
-Docker 安装见: `Docker官方安装文档 <https://docs.docker.com/install/>`_
-
 创建数据库
 ``````````````````
 创建数据库命令行::

docs/faq.rst

@@ -6,6 +6,7 @@ FAQ
    LDAP 使用说明 <faq_ldap.rst>
    SFTP 使用说明 <faq_sftp.rst>
    TELNET 使用说明 <faq_telnet.rst>
+   Docker 使用说明 <faq_docker.rst>
    安装过程 常见问题 <faq_install.rst>
    RDP 协议资产连接说明 <faq_rdp.rst>
    SSH 协议资产连接说明 <faq_ssh.rst>
@@ -128,8 +129,8 @@ FAQ
 
 ::
 
-    # 资产授权就是把 系统用户关联到用户 并授权到 对应的资产
-    # 用户只能看到自己被授权的资产
+    资产授权就是把 系统用户关联到用户 并授权到 对应的资产
+    用户只能看到自己被授权的资产
 
 11. Web Terminal 页面经常需要重新刷新页面才能连接资产
 

docs/faq_docker.rst

+Docker 使用说明
+------------------------------
+
+1. 查看所有镜像
+
+::
+
+    $ docker images
+
+2. 查看所有创建的容器
+
+::
+
+    $ docker ps -a
+
+3. 查看正在运行的容器
+
+::
+
+    $ docker ps
+
+4. 进入正在运行的容器
+
+::
+
+    $ docker exec -it <容器的 CONTAINER ID 或者 容器 NAMES > /bin/bash
+
+    # 例:
+    $ docker ps
+    CONTAINER ID    IMAGE                        COMMAND    CREATED        STATUS       PORTS                     NAMES
+    ecda634206af    jumpserver/guacamole:test    "/init"    12 days ago    Up 3 days    0.0.0.0:8081->8080/tcp    jms_guacamole
+
+    $ docker exec -it ecda634206af /bin/bash 或 docker exec -it jms_guacamole /bin/bash
+
+5. 开始 停止 重启 容器
+
+::
+
+    $ docker start <容器的 CONTAINER ID 或者 容器 NAMES >
+    $ docker stop <容器的 CONTAINER ID 或者 容器 NAMES >
+    $ docker restart <容器的 CONTAINER ID 或者 容器 NAMES >
+
+    # 例:
+    $ docker ps
+    CONTAINER ID    IMAGE                        COMMAND    CREATED        STATUS       PORTS                     NAMES
+    ecda634206af    jumpserver/guacamole:test    "/init"    12 days ago    Up 3 days    0.0.0.0:8081->8080/tcp    jms_guacamole
+
+    $ docker start ecda634206af 或 docker start jms_guacamole
+    $ docker stop ecda634206af 或 docker stop jms_guacamole
+    $ docker restart ecda634206af 或 docker restart jms_guacamole
+
+6. 查看容器 log
+
+::
+
+    $ docker logs -f <容器的 CONTAINER ID 或者 容器 NAMES >
+
+    # 例:
+    $ docker ps
+    CONTAINER ID    IMAGE                        COMMAND    CREATED        STATUS       PORTS                     NAMES
+    ecda634206af    jumpserver/guacamole:test    "/init"    12 days ago    Up 3 days    0.0.0.0:8081->8080/tcp    jms_guacamole
+
+    $ docker logs -f ecda634206af 或 docker logs -f jms_guacamole
+
+7. 删除容器
+
+::
+
+    $ docker rm <容器的 CONTAINER ID 或者 容器 NAMES >
+
+    # 例:
+    $ docker ps
+    CONTAINER ID    IMAGE                        COMMAND    CREATED        STATUS       PORTS                     NAMES
+    ecda634206af    jumpserver/guacamole:test    "/init"    12 days ago    Up 3 days    0.0.0.0:8081->8080/tcp    jms_guacamole
+
+    $ docker rm ecda634206af 或 docker rm jms_guacamole
+
+8. 删除镜像
+
+
+::
+
+    $ docker rmi <镜像的 CONTAINER ID>
+
+    # 例:
+    $ docker images
+    REPOSITORY             TAG     IMAGE ID        CREATED        SIZE
+    jumpserver/guacamole   test    e0c2ec53a8fd    13 days ago    1.23GB
+
+    $ docker rmi e0c2ec53a8fd

docs/installation.rst

@@ -4,9 +4,10 @@
 .. toctree::
    :maxdepth: 1
 
-   quickinstall
    dockerinstall
    step_by_step
    setup_by_ubuntu
+   quickinstall
    setup_by_optimization
+   start_automatically
    upgrade

docs/setup_by_centos7.rst

@@ -163,7 +163,7 @@ CentOS 7 安装文档
 
         # Django 监听的ip和端口，生产环境推荐把0.0.0.0修改成127.0.0.1，这里的意思是允许x.x.x.x访问，127.0.0.1表示仅允许自身访问
         # ./manage.py runserver 127.0.0.1:8080
-        HTTP_BIND_HOST = '127.0.0.1'
+        HTTP_BIND_HOST = '0.0.0.0'
         HTTP_LISTEN_PORT = 8080
 
         # Redis 相关设置

docs/start_automatically.rst

+开机自启
+------------------
+
+设置 Jumpserver 自启
+
+::
+
+    # 启动
+    $ vim /opt/start_jms.sh
+
+    #!/bin/bash
+    set -e
+
+    # 项目安装位置，默认是/opt
+    Project=/opt
+
+    pid=`ps -ef | grep -v grep | egrep '(gunicorn|celery|beat|cocod)' | awk '{print $2}'`
+    if [ "$pid" != "" ]; then
+        echo -e "\033[31m 检测到 Jumpserver 进程未退出，结束中 \033[0m"
+        cd /opt && sh stop_jms.sh
+        sleep 5s
+        pid1=`ps -ef | grep -v grep | egrep '(gunicorn|celery|beat|cocod)' | awk '{print $2}'`
+        if [ "$pid1" != "" ]; then
+            echo -e "\033[31m 检测到 Jumpserver 进程任未退出，强制结束中 \033[0m"
+            kill -9 ${pid1}
+        fi
+    fi
+
+    echo -e "\033[31m 正常启动 Jumpserver ... \033[0m"
+    source $Project/py3/bin/activate
+    cd $Project/jumpserver && ./jms start -d
+    /etc/init.d/guacd start
+    sh /config/tomcat8/bin/startup.sh
+    cd $Project/coco && ./cocod start -d
+
+    exit 0
+
+::
+
+    # 停止
+    $ vim /opt/stop_jms.sh
+
+    #!/bin/bash
+    set -e
+
+    # 项目安装位置，默认是/opt
+    Project=/opt
+
+    source $Project/py3/bin/activate
+    cd $Project/coco && ./cocod stop
+    /etc/init.d/guacd stop
+    sh /config/tomcat8/bin/shutdown.sh
+    cd $Project/jumpserver && ./jms stop
+
+    exit 0
+
+::
+
+    # 写入 rc.local
+    $ chmod +x /etc/rc.local
+    $ echo "sh /opt/start_jms.sh" >> /etc/rc.local

docs/upgrade.rst

-在线更新升级
+更新升级
 -------------
 
 说明
@@ -37,6 +37,7 @@
     $ cp config_example.py config.py
     $ vim config.py  # 参考安装文档进行修改
 
+    # 所有版本都需要执行此步骤
     $ pip install -r requirements/requirements.txt
     $ cd utils && sh make_migrations.sh
 
@@ -52,6 +53,7 @@
     # 任意版本升级到 1.4.0 版本，需要执行（升级前版本小于 1.4.0 需要执行此步骤）
     $ sh 2018_07_15_set_win_protocol_to_ssh.sh
 
+    # 启动 jumpserver
     $ cd ../ && ./jms start all
 
     # 任意版本升级到 1.4.2 版本，需要修改 nginx 配置 （升级前版本小于 1.4.2 需要执行此步骤）
@@ -116,19 +118,24 @@
 
 ::
 
-    $ docker pull jumpserver/guacamole:latest
-    # 如果镜像不是 jumpserver/guacamole，请修改成 registry.jumpserver.org/public/guacamole
-    $ docker stop jms_guacamole  # 或者写guacamole的容器ID
-    $ 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://<填写Jumpserver的url地址> \
-      jumpserver/guacamole:latest
-
-    # 确定升级完成后，可以删除备份容器
-    $ docker rm jms_guacamole_bak
-
+    /etc/init.d/guacd stop
+    sh /config/tomcat8/bin/shutdown.sh
+    $ cd /opt/docker-guacamole
+    $ git pull
+    $ tar -xf guacamole-server-0.9.14.tar.gz
+    $ cd guacamole-server-0.9.14
+    $ autoreconf -fi
+    $ ./configure --with-init-dir=/etc/init.d
+    $ make && make install
+    $ cd ..
+    $ rm -rf guacamole-server-0.9.14.tar.gz guacamole-server-0.9.14
+    $ ldconfig
+    $ cp guacamole-auth-jumpserver-0.9.14.jar /config/guacamole/extensions/guacamole-auth-jumpserver-0.9.14.jar
+    $ cp root/app/guacamole/guacamole.properties /config/guacamole/
+    $ cp guacamole-0.9.14.war /config/tomcat8/webapps/ROOT.war
+
+    $ /etc/init.d/guacd start
+    $ sh /config/tomcat8/bin/startup.sh
 
 切换分支或releases包升级
 -------------------------------
@@ -248,4 +255,4 @@ coco 是无状态的，备份 keys 目录即可
 
 **Guacamole**
 
-直接参考上面的升级即可, 需要注意的是如果更换机器，请备份
+直接参考上面的升级即可