修改文档

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>

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**
 
-直接参考上面的升级即可, 需要注意的是如果更换机器，请备份
+直接参考上面的升级即可