Merge pull request #2505 from wojiushixiaobai/docs

[Update]更新文档

docs/dockerinstall.rst

@@ -40,7 +40,6 @@ XShell等工具请添加 connection 连接, 默认 ssh 端口 2222
 ```````````````
 - mysql 版本需要大于等于 5.6
 - mariadb 版本需要大于等于 5.5.6
-- PostgreSQL 版本需要大于等于 9.4
 - 数据库编码要求 uft8
 
 创建数据库
@@ -58,7 +57,6 @@ XShell等工具请添加 connection 连接, 默认 ssh 端口 2222
 ```````````````
 - SECRET_KEY = ******
 - BOOTSTRAP_TOKEN = ******
-- DB_ENGINE = mysql
 - DB_HOST = mysql_host
 - DB_PORT = 3306
 - DB_USER = jumpserver

docs/faq.rst

@@ -196,7 +196,7 @@ FAQ
     $ systemctl stop firewalld.service  # 临时关闭防火墙, 重启后失效
 
     # Centos 7 如需永久关闭, 还需执行下面步骤
-    $ sed -i "s/enforcing/disabled/g" /etc/selinux/config  # 禁用 selinux
+    $ sed -i "s/SELINUX=enforcing/SELINUX=disabled/g" /etc/selinux/config  # 禁用 selinux
     $ systemctl disable firewalld.service  # 禁用防火墙
 
     # Centos 7 在不关闭 selinux 和 防火墙 的情况下使用 Jumpserver

docs/setup_by_centos7.rst

@@ -38,7 +38,7 @@ CentOS 7 安装文档
     $ firewall-cmd --reload  # 重新载入规则
 
     $ setenforce 0
-    $ sed -i "s/enforcing/disabled/g" /etc/selinux/config
+    $ sed -i "s/SELINUX=enforcing/SELINUX=disabled/g" /etc/selinux/config
 
     # 修改字符集, 否则可能报 input/output error的问题, 因为日志里打印了中文
     $ localedef -c -f UTF-8 -i zh_CN zh_CN.UTF-8

docs/setup_by_fast.rst

@@ -16,7 +16,7 @@
 
     $ echo -e "\033[31m 1. 防火墙 Selinux 设置 \033[0m" \
       && if [ "$(systemctl status firewalld | grep running)" != "" ]; then firewall-cmd --zone=public --add-port=80/tcp --permanent; firewall-cmd --zone=public --add-port=2222/tcp --permanent; firewall-cmd --permanent --add-rich-rule="rule family="ipv4" source address="172.17.0.0/16" port protocol="tcp" port="8080" accept"; firewall-cmd --reload; fi \
-      && if [ "$(getenforce)" != "Disabled" ]; then setenforce 0; sed -i "s/enforcing/disabled/g" /etc/selinux/config; fi
+      && if [ "$(getenforce)" != "Disabled" ]; then setsebool -P httpd_can_network_connect 1; fi
 
 .. code-block:: shell
 

docs/start_automatically.rst

 开机自启
 ------------------
 
-正常部署设置自启
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. code-block:: shell
-
-    # 启动
-    $ vi /opt/start_jms.sh
-
-    #!/bin/bash
-    set -e
-
-    export LANG=zh_CN.UTF-8
-
-    # 项目安装位置, 默认是/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"
-
-    # jumpserver
-    source $Project/py3/bin/activate
-    cd $Project/jumpserver && ./jms start -d
-
-    # guacamole
-    export GUACAMOLE_HOME=/config/guacamole
-    export JUMPSERVER_KEY_DIR=/config/guacamole/keys
-    export JUMPSERVER_SERVER=http://127.0.0.1:8080
-    export BOOTSTRAP_TOKEN=******  # 根据实际情况修改
-    /etc/init.d/guacd start
-    cd /config/tomcat8/bin && ./startup.sh
-
-    # coco
-    cd $Project/coco && ./cocod start -d
-
-    exit 0
-
-.. code-block:: shell
-
-    # 停止
-    $ vi /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
-    cd /config/tomcat8/bin && ./shutdown.sh
-    cd $Project/jumpserver && ./jms stop
-
-    exit 0
-
-.. code-block:: shell
-
-    # 写入 rc.local
-    $ chmod +x /etc/rc.local
-    $ echo "sh /opt/start_jms.sh" >> /etc/rc.local
-
-
-Docker 组件部署设置自启
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. code-block:: shell
-
-    # 启动
-    $ vi /opt/start_jms.sh
-
-    #!/bin/bash
-    set -e
-
-    export LANG=zh_CN.UTF-8
-
-    # 项目安装位置, 默认是/opt
-    Project=/opt
-
-    pid=`ps -ef | grep -v grep | egrep '(gunicorn|celery|beat)' | 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)' | 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
-    docker start jms_coco
-    docker start jms_guacamole
-
-    exit 0
-
-.. code-block:: shell
-
-    # 停止
-    $ vi /opt/stop_jms.sh
-
-    #!/bin/bash
-    set -e
-
-    # 项目安装位置, 默认是/opt
-    Project=/opt
-
-    docker stop jms_coco
-    docker stop jms_guacamole
-    source $Project/py3/bin/activate
-    cd $Project/jumpserver && ./jms stop
-
-    exit 0
-
-.. code-block:: shell
-
-    # 写入 rc.local
-    $ chmod +x /etc/rc.local
-    $ echo "sh /opt/start_jms.sh" >> /etc/rc.local
-
-
 Systemd 管理启动 Jumpserver
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. code-block:: shell
+- 一步一步安装适用 (CentOS 7)
 
-    # 适合按照一步一步文档进行安装的用户, Centos 7
+.. code-block:: vim
 
     # Jumpserver
     $ vi /usr/lib/systemd/system/jms.service
@@ -159,6 +25,8 @@ Systemd 管理启动 Jumpserver
     [Install]
     WantedBy=multi-user.target
 
+.. code-block:: vim
+
     # Coco
     $ vi /usr/lib/systemd/system/coco.service
     [Unit]
@@ -176,6 +44,8 @@ Systemd 管理启动 Jumpserver
     [Install]
     WantedBy=multi-user.target
 
+.. code-block:: vim
+
     # Guacamole
     $ chkconfig guacd on
     $ vi /usr/lib/systemd/system/guacamole.service
@@ -196,6 +66,8 @@ Systemd 管理启动 Jumpserver
     [Install]
     WantedBy=multi-user.target
 
+.. code-block:: shell
+
     # 开机自启设置
     $ systemctl enable jms
     $ systemctl enable coco
@@ -210,3 +82,64 @@ Systemd 管理启动 Jumpserver
     $ systemctl stop jms
     $ systemctl stop coco
     $ systemctl stop guacamole
+
+Docker 组件部署设置自启
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- 极速安装适用 (CentOS 7)
+- 一体化部署适用 (CentOS 7)
+
+.. code-block:: vim
+
+    # Jumpserver
+    $ vi /usr/lib/systemd/system/jms.service
+    [Unit]
+    Description=jms
+    After=network.target mariadb.service redis.service docker.service
+    Wants=mariadb.service redis.service docker.service
+
+    [Service]
+    Type=forking
+    Environment="PATH=/opt/py3/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin"
+    ExecStart=/opt/jumpserver/jms start all -d
+    ExecReload=
+    ExecStop=/opt/jumpserver/jms stop
+
+    [Install]
+    WantedBy=multi-user.target
+
+.. code-block:: vim
+
+    # 启动
+    $ vi /opt/start_jms.sh
+
+    #!/bin/bash
+    set -e
+
+    export LANG=zh_CN.UTF-8
+
+    systemctl start jms
+    docker start jms_coco
+    docker start jms_guacamole
+
+    exit 0
+
+.. code-block:: vim
+
+    # 停止
+    $ vi /opt/stop_jms.sh
+
+    #!/bin/bash
+    set -e
+
+    docker stop jms_coco
+    docker stop jms_guacamole
+    systemctl stop jms
+
+    exit 0
+
+.. code-block:: shell
+
+    # 写入 rc.local
+    $ chmod +x /etc/rc.d/rc.local
+    $ if [ "$(cat /etc/rc.local | grep start_jms.sh)" == "" ]; then echo "sh /opt/start_jms.sh" >> /etc/rc.local; fi

docs/step_by_step.rst

@@ -29,7 +29,7 @@
     $ firewall-cmd --reload  # 重新载入规则
 
     $ setenforce 0
-    $ sed -i "s/enforcing/disabled/g" /etc/selinux/config
+    $ sed -i "s/SELINUX=enforcing/SELINUX=disabled/g" /etc/selinux/config
 
     # 修改字符集, 否则可能报 input/output error的问题, 因为日志里打印了中文
     $ localedef -c -f UTF-8 -i zh_CN zh_CN.UTF-8