Merge pull request #2143 from wojiushixiaobai/docs

 [Update]v1.4.5更新文档

docs/change_log.rst

 更新日志
 ===========
 
+1.4.5
+------------------------
+2018年12月12日
+* 统一维护migrations数据库表结构变更
+* 系统配置内容支持热加载，不用再重启 jumpserver
+* coco，guacamole注册机制更改，使用预共享秘钥自动注册，不再需要接受注册
+* 用户密码过期时间设置
+* ldap不可以修改密码
+* 默认组织里可以看到所有用户
+* 日志审计修改密码日志中只能看到当前组织用户的更改
+* luna列表回滚为原来方式，不再是异步加载
+* rdp支持分辨率更改
+
 1.4.4
 ------------------------
 2018年11月11日

docs/distributed_02.rst

@@ -60,7 +60,7 @@
     # 下载 luna
     $ cd /opt
     $ wget https://github.com/jumpserver/luna/releases/download/v1.4.4/luna.tar.gz
-    $ tar xvf luna.tar.gz
+    $ tar xf luna.tar.gz
     $ chown -R root:root luna
 
 .. code-block:: nginx

docs/faq_upgrade.rst

@@ -23,3 +23,70 @@
 
     # 这是因为你的数据库版本不对, 从 1.4.x 版本开始 mysql 版本需要大于等于 5.6, mariadb 版本需要大于等于 5.5.6
     # 请更换数据库重新操作
+
+3. 数据库表结构不完整导致升级失败的, 按如下内容进行处理
+
+.. code-block:: shell
+
+    # 一定要知道自己升级之前的版本, 在升级之前可以通过如下代码进行查询, 记住是升级之前, 也可以通过 web 页面的右下角来查看当前版本信息
+    $ cat /opt/jumpserver/apps/__init__.py | grep version
+    $ cat /opt/jumpserver/apps/templates/_footer.html | grep Version
+
+    # 备份当前版本数据库, 忽略 django_migrations 表
+    $ mysqldump -uroot -p jumpserver --ignore-table=jumpserver.django_migrations > /opt/jumpserver.sql
+
+    # 重命名 Jumpserver 目录
+    $ mv /opt/jumpserver /opt/jumpserver_bak
+
+    # 重新 clone 代码
+    $ cd /opt
+    $ git clone https://github.com/jumpserver/jumpserver.git
+    $ cd jumpserver
+
+    # 检出你之前的版本, 比如之前的版本是1.4.0
+    $ git checkout 1.4.0  # 1.4.0 表示版本号, 自己手动更换成你当前的版本, 如 1.3.1 则输入 git checkout 1.3.1
+
+    # 依赖安装
+    $ source /opt/py3/bin/activate
+    $ yum -y install $(cat /opt/jumpserver/requirements/rpm_requirements.txt)
+    $ pip install --upgrade pip setuptools
+    $ pip install -r /opt/jumpserver/requirements/requirements.txt
+
+    # 重新创建一个数据库
+    $ mysql -uroot
+    > create database jumpserver01 default charset 'utf8';
+    > grant all on jumpserver01.* to 'jumpserver01'@'127.0.0.1' identified by 'weakPassword';
+    > flush privileges;
+    > quit
+
+    # 修改配置文件
+    $ cp /opt/jumpserver_bak/config.py /opt/jumpserver/
+    $ vim /opt/jumpserver/config.py
+    DB_ENGINE = 'mysql'
+    DB_HOST = '127.0.0.1'
+    DB_PORT = 3306
+    DB_USER = 'jumpserver01'
+    DB_PASSWORD = 'weakPassword'
+    DB_NAME = 'jumpserver01'
+
+    # 初始化数据库
+    $ cd /opt/jumpserver/utils
+    $ sh make_migrations.sh
+
+    # 确定初始化没有错误, 把旧的数据库导入
+    $ mysql -uroot
+    > use jumpserver01;
+    > source /opt/jumpserver.sql
+
+    # 启动 jumpserver, 确定没有错误
+    $ cd /opt/jumpserver
+    $ ./jms start all
+
+    # 打开 web 页面检查是否都正常
+
+    $ 参考升级文档继续升级到最新版本即可
+
+    # 删除原数据库命令
+    $ mysql -uroot
+    > drop database jumpserver;
+    > quit

docs/setup_by_centos7.rst

@@ -60,7 +60,7 @@ CentOS 7 安装文档
     > create database jumpserver default charset 'utf8';
     > grant all on jumpserver.* to 'jumpserver'@'127.0.0.1' identified by 'weakPassword';
     > flush privileges;
-    > quit;
+    > quit
 
     # 安装 Nginx ,用作代理服务器整合 Jumpserver 与各个组件
     $ vi /etc/yum.repos.d/nginx.repo
@@ -225,7 +225,7 @@ CentOS 7 安装文档
     # 安装 Web Terminal 前端: Luna  需要 Nginx 来运行访问 访问(https://github.com/jumpserver/luna/releases)下载对应版本的 release 包,直接解压,不需要编译
     $ cd /opt
     $ wget https://github.com/jumpserver/luna/releases/download/v1.4.4/luna.tar.gz
-    $ tar xvf luna.tar.gz
+    $ tar xf luna.tar.gz
     $ chown -R root:root luna
 
 .. code-block:: shell

docs/setup_by_ubuntu.rst

@@ -378,7 +378,7 @@ Luna 已改为纯前端,需要 Nginx 来运行访问
 
     $ cd /opt/
     $ wget https://github.com/jumpserver/luna/releases/download/v1.4.4/luna.tar.gz
-    $ tar xvf luna.tar.gz
+    $ tar xf luna.tar.gz
     $ chown -R root:root luna
 
 五. 安装 Windows 支持组件(如果不需要管理 windows 资产,可以直接跳过这一步)

docs/step_by_step.rst

@@ -410,7 +410,7 @@ Luna 已改为纯前端,需要 Nginx 来运行访问
 
     $ cd /opt
     $ wget https://github.com/jumpserver/luna/releases/download/v1.4.4/luna.tar.gz
-    $ tar xvf luna.tar.gz
+    $ tar xf luna.tar.gz
     $ chown -R root:root luna
 
 五. 安装 Windows 支持组件(如果不需要管理 windows 资产,可以直接跳过这一步)

docs/upgrade.rst

@@ -22,26 +22,21 @@
     > use jumpserver;
     > select app,name from django_migrations where app in('assets','audits','common','ops','orgs','perms','terminal','users') order by app asc;
 
-    # 如果左右对比信息不一致,请勿升级,升级必然失败
+    # 如果左右对比信息不一致, 通过升级常见问题解决
 
-1. 备份 Jumpserver 数据库表结构 (通过releases包升级需要还原这些文件)
+丢失表结构文件参考 `升级常见问题 <faq_upgrade.html>`_
+
+1. 备份 Jumpserver
 
 .. code-block:: shell
 
-    $ jumpserver_backup=/tmp/jumpserver_backup
-    $ mkdir -p $jumpserver_backup
-    $ cd /opt/jumpserver/apps
-    $ for d in $(ls);do
-        if [ -d $d ] && [ -d $d/migrations ];then
-          mkdir -p $jumpserver_backup/${d}/migrations
-          cp ${d}/migrations/*.py $jumpserver_backup/${d}/migrations/
-        fi
-      done
+    $ cp -r /opt/jumpserver /opt/jumpserver_bak
+    $ mysqldump -uroot -p jumpserver --ignore-table=jumpserver.django_migrations > /opt/jumpserver.sql
 
 .. code-block:: shell
 
-    # 还原代码 (通过releases包升级需要还原这些文件,通过git pull升级不需要执行)
-    $ cd $jumpserver_backup/
+    # 通过 releases 包升级需要还原这些文件,通过 git pull 升级不需要执行
+    $ cd /opt/jumpserver_bak/apps
     $ for d in $(ls);do
         if [ -d $d ] && [ -d $d/migrations ];then
           cp ${d}/migrations/*.py /opt/jumpserver/apps/${d}/migrations/
@@ -55,8 +50,9 @@
     # 升级前请做好 jumpserver 目录与 数据库 备份,谨防意外
     $ cd /opt/jumpserver
     $ source /opt/py3/bin/activate
-    $ git pull
     $ ./jms stop
+    $ git pull
+    $ git checkout 1.4.4
 
 .. code-block:: shell
 
@@ -78,7 +74,7 @@
 
 .. code-block:: shell
 
-    # 任意版本升级到 1.4.0 版本,需要执行(升级前版本小于 1.4.0 需要执行此步骤)
+    # 任意版本升级到 1.4.0 版本,需要执行(升级前版本小于 1.4.0 需要执行此步骤, 没有此文件则跳过)
     $ sh 2018_07_15_set_win_protocol_to_ssh.sh
 
 .. code-block:: shell
@@ -166,10 +162,10 @@
     $ cd /opt
     $ rm -rf luna
     $ wget https://github.com/jumpserver/luna/releases/download/v1.4.4/luna.tar.gz
-    $ tar xvf luna.tar.gz
+    $ tar xf luna.tar.gz
     $ chown -R root:root luna
 
-    # 注意把浏览器缓存刷新下
+    # 注意把浏览器缓存清理下
 
 6. Docker 部署 coco guacamole 升级说明
 
@@ -188,7 +184,7 @@
     # 到 Web 会话管理 - 终端管理 接受新的注册
 
 
-1.4.4 升级到 1.4.5 (未开放, 等待更新)
+1.4.4 升级到 1.4.5
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - 当前版本必须是 1.4.4 版本,否则请先升级到 1.4.4
@@ -204,26 +200,19 @@
 
 .. code-block:: shell
 
-    # 备份数据库表结构文件
-    $ jumpserver_backup=/tmp/jumpserver_backup
-    $ mkdir -p $jumpserver_backup
-    $ mv config.py $jumpserver_backup/
-    $ cd /opt/jumpserver/apps
-    $ for d in $(ls);do
-        if [ -d $d ] && [ -d $d/migrations ];then
-          mkdir -p $jumpserver_backup/${d}/migrations
-          cp ${d}/migrations/*.py $jumpserver_backup/${d}/migrations/
-        fi
-      done
-
+    # 备份 Jumpserver
+    $ cp -r /opt/jumpserver /opt/jumpserver_bak
+    $ cd /opt/jumpserver
     $ sh utils/clean_migrations.sh
 
 .. code-block:: shell
 
     $ cd /opt/jumpserver
+    $ git checkout master
     $ git pull
 
     # 更新 config.py ,请根据你原备份的 config.py 内容进行修改
+    $ mv config.py config_1.4.4.bak
     $ cp config_example.py config.py
     $ vi config.py
 
@@ -247,9 +236,11 @@
         """
         Jumpserver Config File
         Jumpserver 配置文件
+
         Jumpserver use this config for drive django framework running,
         You can set is value or set the same envirment value,
         Jumpserver look for config order: file => env => default
+
         Jumpserver使用配置来驱动Django框架的运行，
         你可以在该文件中设置，或者设置同样名称的环境变量,
         Jumpserver使用配置的顺序: 文件 => 环境变量 => 默认值
@@ -499,7 +490,7 @@
     $ cd /opt
     $ rm -rf luna
     $ wget https://github.com/jumpserver/luna/releases/download/v1.4.5/luna.tar.gz
-    $ tar xvf luna.tar.gz
+    $ tar xf luna.tar.gz
     $ chown -R root:root luna
 
 **Docker Coco Guacamole**