Merge pull request #2487 from wojiushixiaobai/docs

[Update]更新文档

docs/dockerinstall.rst

@@ -13,14 +13,15 @@ Tips: 不建议在生产中使用, 因为所有软件都打包到一个Docker中
 
 .. code-block:: shell
 
-    $ SECRET_KEY=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 50`  # 生成加密秘钥, 勿外泄
-    $ BOOTSTRAP_TOKEN=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 16`  # 生成组件注册所需Token, 勿外泄
+    # 生成随机加密秘钥, 勿外泄
+    $ if [ "$SECRET_KEY" = "" ]; then SECRET_KEY=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 50`; echo "SECRET_KEY=$SECRET_KEY" >> ~/.bashrc; echo $SECRET_KEY; else echo $SECRET_KEY; fi
+    $ if [ "$BOOTSTRAP_TOKEN" = "" ]; then BOOTSTRAP_TOKEN=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 16`; echo "BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bashrc; echo $BOOTSTRAP_TOKEN; else echo $BOOTSTRAP_TOKEN; fi
 
     $ docker run --name jms_all -d -p 80:80 -p 2222:2222 -e SECRET_KEY=$SECRET_KEY -e BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN jumpserver/jms_all:latest
 
     # macOS 生成随机 key 可以用下面的命令
-    $ SECRET_KEY=`LC_CTYPE=C tr -dc A-Za-z0-9 < /dev/urandom | head -c 50`  # 生成加密秘钥, 勿外泄
-    $ BOOTSTRAP_TOKEN=`LC_CTYPE=C tr -dc A-Za-z0-9 < /dev/urandom | head -c 16`  # 生成组件注册所需Token, 勿外泄
+    $ if [ "$SECRET_KEY" = "" ]; then SECRET_KEY=`LC_CTYPE=C tr -dc A-Za-z0-9 < /dev/urandom | head -c 50`; echo "SECRET_KEY=$SECRET_KEY" >> ~/.bash_profile; echo $SECRET_KEY; else echo $SECRET_KEY; fi
+    $ if [ "$BOOTSTRAP_TOKEN" = "" ]; then BOOTSTRAP_TOKEN=`LC_CTYPE=C tr -dc A-Za-z0-9 < /dev/urandom | head -c 16`; echo "BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bash_profile; echo $BOOTSTRAP_TOKEN; else echo $BOOTSTRAP_TOKEN; fi
 
 环境迁移和更新升级请检查 SECRET_KEY 是否与之前设置一致, 不能随机生成, 否则数据库所有加密的字段均无法解密
 

docs/setup_by_centos7.rst

@@ -104,7 +104,9 @@ CentOS 7 安装文档
     $ cp config_example.yml config.yml
 
     $ SECRET_KEY=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 50`  # 生成随机SECRET_KEY
+    $ echo "SECRET_KEY=$SECRET_KEY" >> ~/.bashrc
     $ BOOTSTRAP_TOKEN=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 16`  # 生成随机BOOTSTRAP_TOKEN
+    $ echo "BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bashrc
 
     $ sed -i "s/SECRET_KEY:/SECRET_KEY: $SECRET_KEY/g" /opt/jumpserver/config.yml
     $ sed -i "s/BOOTSTRAP_TOKEN:/BOOTSTRAP_TOKEN: $BOOTSTRAP_TOKEN/g" /opt/jumpserver/config.yml

docs/setup_by_fast.rst

@@ -131,7 +131,9 @@
     $ systemctl start nginx \
       && DB_PASSWORD=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 24` \
       && SECRET_KEY=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 50` \
+      && echo "SECRET_KEY=$SECRET_KEY" >> ~/.bashrc \
       && BOOTSTRAP_TOKEN=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 16` \
+      && echo "BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bashrc \
       && cp /opt/jumpserver/config_example.yml /opt/jumpserver/config.yml \
       && Server_IP=`ip addr | grep inet | egrep -v '(127.0.0.1|inet6|docker)' | awk '{print $2}' | tr -d "addr:" | head -n 1 | cut -d / -f1` \
       && mysql -uroot -e "create database jumpserver default charset 'utf8';grant all on jumpserver.* to 'jumpserver'@'127.0.0.1' identified by '$DB_PASSWORD';flush privileges;" \
@@ -152,3 +154,4 @@
       && echo -e "\033[31m 你的SECRET_KEY是 $SECRET_KEY \033[0m" \
       && echo -e "\033[31m 你的BOOTSTRAP_TOKEN是 $BOOTSTRAP_TOKEN \033[0m" \
       && echo -e "\033[31m 你的服务器IP是 $Server_IP \033[0m"
+      && echo -e "\033[31m 请打开浏览器访问 http://$Server_IP 用户名:admin 密码:admin \033[0m"

docs/setup_by_ubuntu.rst

@@ -114,7 +114,9 @@
     $ cp config_example.yml config.yml
 
     $ SECRET_KEY=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 50`  # 生成随机SECRET_KEY
+    $ echo "SECRET_KEY=$SECRET_KEY" >> ~/.bashrc
     $ BOOTSTRAP_TOKEN=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 16`  # 生成随机BOOTSTRAP_TOKEN
+    $ echo "BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bashrc
 
     $ sed -i "s/SECRET_KEY:/SECRET_KEY: $SECRET_KEY/g" /opt/jumpserver/config.yml
     $ sed -i "s/BOOTSTRAP_TOKEN:/BOOTSTRAP_TOKEN: $BOOTSTRAP_TOKEN/g" /opt/jumpserver/config.yml

docs/setup_by_ubuntu18.rst

@@ -109,7 +109,9 @@ Ubuntu 18.04 安装文档
     $ cp config_example.yml config.yml
 
     $ SECRET_KEY=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 50`  # 生成随机SECRET_KEY
+    $ echo "SECRET_KEY=$SECRET_KEY" >> ~/.bashrc
     $ BOOTSTRAP_TOKEN=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 16`  # 生成随机BOOTSTRAP_TOKEN
+    $ echo "BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bashrc
 
     $ sed -i "s/SECRET_KEY:/SECRET_KEY: $SECRET_KEY/g" /opt/jumpserver/config.yml
     $ sed -i "s/BOOTSTRAP_TOKEN:/BOOTSTRAP_TOKEN: $BOOTSTRAP_TOKEN/g" /opt/jumpserver/config.yml

docs/step_by_step.rst

@@ -132,7 +132,9 @@
     $ cp config_example.yml config.yml
 
     $ SECRET_KEY=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 50`  # 生成随机SECRET_KEY
+    $ echo "BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bashrc
     $ BOOTSTRAP_TOKEN=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 16`  # 生成随机BOOTSTRAP_TOKEN
+    $ echo "BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bashrc
 
     $ sed -i "s/SECRET_KEY:/SECRET_KEY: $SECRET_KEY/g" /opt/jumpserver/config.yml
     $ sed -i "s/BOOTSTRAP_TOKEN:/BOOTSTRAP_TOKEN: $BOOTSTRAP_TOKEN/g" /opt/jumpserver/config.yml

docs/upgrade.rst

@@ -266,6 +266,9 @@
     # 更新 config.yml, 请根据你原备份的 config.yml 内容进行修改
     $ mv config.py config_1.4.4.bak
     $ cp config_example.yml config.yml
+    $ BOOTSTRAP_TOKEN=`cat /dev/urandom | tr -dc A-Za-z0-9 | head -c 16`  # 生成随机 BOOTSTRAP_TOKEN
+    $ sed -i "s/BOOTSTRAP_TOKEN:/BOOTSTRAP_TOKEN: $BOOTSTRAP_TOKEN/g" /opt/jumpserver/config.yml
+    $ echo "BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bashrc
     $ vi config.yml
 
 .. code-block:: vim
@@ -386,6 +389,8 @@
 
     # 更新 config.yml, 请根据你原备份的 conf.bak 内容进行修改
     $ cp config_example.yml config.yml
+    $ sed -i "s/BOOTSTRAP_TOKEN: <PleasgeChangeSameWithJumpserver>/BOOTSTRAP_TOKEN: $BOOTSTRAP_TOKEN/g" /opt/coco/config.yml
+    $ sed -i "s/# LOG_LEVEL: INFO/LOG_LEVEL: ERROR/g" /opt/coco/config.yml
     $ vi config.yml
 
 .. code-block:: vim
@@ -474,8 +479,8 @@
     $ chmod +x /bin/ssh-forward
 
     # BOOTSTRAP_TOKEN 请和 jumpserver 配置文件中保持一致
-    $ export BOOTSTRAP_TOKEN=*****
-    $ echo "export BOOTSTRAP_TOKEN=*****" >> ~/.bashrc
+    $ export BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN
+    $ echo "export BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN" >> ~/.bashrc
 
     $ /etc/init.d/guacd start
     $ sh /config/tomcat8/bin/startup.sh
@@ -509,8 +514,9 @@
     $ docker pull jumpserver/jms_guacamole:1.4.8
 
     # BOOTSTRAP_TOKEN 请和 jumpserver 配置文件中保持一致
-    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=***** jumpserver/jms_coco:1.4.8
-    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=***** jumpserver/jms_guacamole:1.4.8
+    $ Server_IP=`ip addr | grep inet | egrep -v '(127.0.0.1|inet6|docker)' | awk '{print $2}' | tr -d "addr:" | head -n 1 | cut -d / -f1`
+    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://$Server_IP:8080 -e BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN jumpserver/jms_coco:1.4.8
+    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://$Server_IP:8080 -e BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN jumpserver/jms_guacamole:1.4.8
 
     # 到 Web 会话管理 - 终端管理 查看组件是否已经在线
 
@@ -1061,3 +1067,75 @@
     $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=****** jumpserver/jms_guacamole:1.4.8
 
     # 到 Web 会话管理 - 终端管理 查看组件是否已经在线
+
+1.4.8 升级到最新版本
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Jumpserver**
+
+.. code-block:: shell
+
+    $ cd /opt/jumpserver
+    $ source /opt/py3/bin/activate
+    $ git pull
+    $ pip install -r requirements/requirements.txt
+
+    $ cd ../
+    $ ./jms start all -d
+
+**Coco**
+
+说明: Docker 部署的请跳过
+
+.. code-block:: shell
+
+    $ cd /opt/coco
+    $ git pull
+    $ source /opt/py3/bin/activate
+    $ pip install -r requirements/requirements.txt
+    $ ./cocod start -d
+
+**Guacamole**
+
+说明: Docker 部署的请跳过
+
+.. code-block:: shell
+
+    $ cd /opt/docker-guacamole
+    $ git pull
+    $ /etc/init.d/guacd stop
+    $ sh /config/tomcat8/bin/shutdown.sh
+    $ /etc/init.d/guacd start
+    $ sh /config/tomcat8/bin/startup.sh
+
+**Luna**
+
+说明: 直接下载 release 包
+
+.. code-block:: shell
+
+    $ cd /opt
+    $ rm -rf luna
+    $ wget https://github.com/jumpserver/luna/releases/download/1.4.9/luna.tar.gz
+    $ tar xf luna.tar.gz
+    $ chown -R root:root luna
+
+    # 注意把浏览器缓存清理下
+
+**Docker Coco Guacamole**
+
+说明: Docker 部署的 coco 与 guacamole 升级说明
+
+.. code-block:: shell
+
+    # 先到 Web 会话管理 - 终端管理 删掉所有组件
+    $ docker stop jms_coco
+    $ docker stop jms_guacamole
+    $ docker rm jms_coco
+    $ docker rm jms_guacamole
+    $ docker pull jumpserver/jms_coco:1.4.9
+    $ docker pull jumpserver/jms_guacamole:1.4.9
+    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN jumpserver/jms_coco:1.4.9
+    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=$BOOTSTRAP_TOKEN jumpserver/jms_guacamole:1.4.9
+
+    # 到 Web 会话管理 - 终端管理 查看组件是否已经在线