Merge pull request #1216 from wojiushixiaobai/docs

文档更新

docs/quickstart.rst → docs/dockerinstall.rst

-快速安装
+Docker安装
 ==========================
 
 Jumpserver 封装了一个 All in one Docker，可以快速启动。该镜像集成了所需要的组件(Windows组件未暂未集成)，也支持使用外置 Database 和 Redis

docs/faq.rst

 FAQ
 ==========
+.. toctree::
+   :maxdepth: 1
+
+   Windows 资产连接说明 <faq_windows.rst>
+   Windows sftp使用说明 <faq_sftp.rst>
+   二次认证（Google Auth）入口说明 <faq_googleauth.rst>
+
+
+常见问题
+~~~~~~~~~~~~~~~~~~~~~
 
 1. Windows 资产连接错误排查思路
 
@@ -47,10 +57,9 @@ FAQ
 
    (3). guacamole重新注册
 
-      $ rm /opt/guacamole/key/*  # guacamole, 如果你是按文档安装的，key应该在这里
       $ docker stop jms_guacamole  # 如果名称更改过或者不对，请使用docker ps 查询容器的 CONTAINER ID ，然后docker stop <CONTAINER ID>
       $ docker rm jms_guacamole  # 如果名称更改过或者不对，请使用docker ps -a 查询容器的 CONTAINER ID ，然后docker rm <CONTAINER ID>
-      $ rm /opt/guacamole/key/*
+      $ rm /opt/guacamole/key/*  # guacamole, 如果你是按文档安装的，key应该在这里
       $ systemctl stop docker
       $ systemctl start docker
       $ docker run —name jms_guacamole -d \
@@ -165,3 +174,16 @@ FAQ
         $ source /opt/py3/bin/activate
         $ cd /opt/jumpserver/apps
         $ python manage.py changepassword  <user_name>
+
+        # 新建超级用户的命令如下命令
+        $ python manage.py createsuperuser --username=user --email=user@domain.com
+
+    (11). 清理celery产生的数据(无法正常推送及连接资产可以使用)
+        $ source /opt/py3/bin/activate
+        $ cd /opt/jumpserver/apps
+        $ python manage.py shell
+        $ from celery.task.control import discard_all
+        $ discard_all()
+        $ exit()
+        $ cd /opt/jumpserver
+        $ ./jms restart celery

docs/faq_googleauth.rst

+二次认证（Google Auth）入口说明
+--------------------------------------------------------
+
+.. image:: _static/img/faq_googleauth.jpg

docs/faq_sftp.rst

+Windows sftp使用说明
+-------------------------------------------------------
+在Windows上使用 sftp 工具传输文件到 Linux 系统，默认的上传目录在 /tmp ，其他目录没有权限
+
+.. image:: _static/img/faq_sftp_01.jpg

docs/faq_windows.rst

+Windows 资产连接说明
+----------------------------
+
+1. 检查终端是否在线（如果不在线，参考FAQ文档进行处理）
+
+.. image:: _static/img/faq_windows_01.jpg
+
+2. 登录要连接的windows资产，检查用户和IP信息（Windows目前还不支持推送，所以必须使用资产上面已存在的用户进行登录）
+
+.. image:: _static/img/faq_windows_02.jpg
+
+3. 创建Windows资产管理用户（如果是域资产，格式是uesr@domain.com）
+
+.. image:: _static/img/faq_windows_03.jpg
+
+4. 创建Windows资产系统用户（如果是域资产，格式是uesr@domain.com，注意协议不要选错）
+
+.. image:: _static/img/faq_windows_04.jpg
+
+5. 创建Windows资产（注意端口不要填错）
+
+.. image:: _static/img/faq_windows_05.jpg
+
+6. 创建授权规则
+
+.. image:: _static/img/faq_windows_06.jpg
+
+7. 使用web terminal登录（如果登录报错，检查防火墙的设置，可以参考FAQ）
+
+.. image:: _static/img/faq_windows_07.jpg

docs/fool_install.rst

 傻瓜安装
 ==========================
 
-由于大多数用户对 Linux 不熟悉，这里提供基于 CentoOS_7_64 的傻瓜安装脚本。
+由于部分用户对 Linux 不熟悉，这里提供基于 CentoOS_7_64 的傻瓜安装脚本。
 
 本脚本仅支持 CentoOS7 64 位的系统安装 Jumpserver，无法在其他系统中正常运行。
 

docs/installation.rst

@@ -4,7 +4,8 @@
 .. toctree::
    :maxdepth: 1
 
-   quickstart
+   dockerinstall
+   quickinstall
    step_by_step
    setup_by_ubuntu
    upgrade

docs/quickinstall.rst

+快速安装
+++++++++++++++++++++++++
+
+因为懒，所以更专业。
+
+组件解释
+~~~~~~~~~~~~~~
+- Jumpserver 为管理后台，管理员可以通过Web页面进行资产管理、用户管理、资产授权等操作
+- Coco 为 SSH Server 和 Web Terminal Server 。用户可以通过使用自己的账户登录 SSH 或者 Web Terminal 直接访问被授权资产。不需要知道服务器的账户密码
+- Luna 为 Web Terminal Server 前端页面，用户使用 Web Terminal 方式登录所需要的组件
+- Guacamole 为 Windows 组件，用户可以通过 Web Terminal 来连接 Windows 资产 （暂时只能通过 Web Terminal 来访问）
+
+安装文档
+~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 1
+
+   CentOS 7 安装文档 <setup_by_centos7.rst>

docs/setup_by_ubuntu.rst

@@ -44,7 +44,7 @@
     # 看到下面的提示符代表成功，以后运行 Jumpserver 都要先运行以上 source 命令，以下所有命令均在该虚拟环境中运行
     (py3) [root@localhost py3]
 
-二. 安装 Jumpserver 1.0.0
+二. 安装 Jumpserver
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 **2.1 下载或 Clone 项目**

docs/step_by_step.rst

@@ -63,7 +63,7 @@ Yum 加速设置请参考 <http://mirrors.163.com/.help/centos.html>
     # 看到下面的提示符代表成功，以后运行 Jumpserver 都要先运行以上 source 命令，以下所有命令均在该虚拟环境中运行
     (py3) [root@localhost py3]
 
-二. 安装 Jumpserver 1.0.0
+二. 安装 Jumpserver
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 **2.1 下载或 Clone 项目**

docs/upgrade.rst

@@ -6,7 +6,7 @@
 ::
 
     $ git pull && pip install -r requirements/requirements.txt && cd utils && sh make_migrations.sh
-    
+
     # 1.0.x 升级 1.2.0 需要执行迁移脚本（新版本授权管理更新）
     $ sh 2018_04_11_migrate_permissions.sh
  
@@ -14,7 +14,11 @@
 
 ::
 
-    $ git pull && cd requirements && pip install -r requirements.txt -i https://pypi.org/simple
+
+    $ git pull && pip install -r requirements/requirements.txt
+
+    # 如果使用其他源下载失败可以使用 -i 参数指定源
+    $ git pull && pip install -r requirements/requirements.txt -i https://pypi.org/simple
 
 3. 升级 Luna
 
@@ -22,7 +26,7 @@
 
 4. 升级 guacamole
 
-:: 
+::
 
     $ docker pull registry.jumpserver.org/public/guacamole:latest
     $ docker stop jms_guacamole  # 或者写guacamole的容器ID
@@ -30,9 +34,12 @@
     $ 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://<填写本机的IP地址>:8080 \
+      -e JUMPSERVER_SERVER=http://<填写Jumpserver服务器的IP地址>:8080 \
       registry.jumpserver.org/public/guacamole:latest
 
+    # 确定升级完成后，可以删除备份容器
+    $ docker rm jms_guacamole_bak
+
 
 切换分支或离线升级
 -------------------------------
@@ -40,66 +47,40 @@
 
 **Jumpserver**
 
-说明: 以下操作，都在jumpserver所在目录运行（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
+说明: 如果是新开的终端，别忘了 source /opt/py3/bin/activate
 
-1. 备份配置文件
+1. 备份jumpserver
 
 ::
 
     $ jumpserver_backup=/tmp/jumpserver_backup
     $ mkdir -p $jumpserver_backup
-    $ cp config.py $jumpserver_backup
+    $ cd /opt/jumpservrer
+    $ cp -r ./ $jumpserver_backup
 
-2. 备份migrations migrations中存的是数据库表结构的变更，切换分支会丢失
-
-::
-
-   $ for app in common users assets ops perms terminal;do
-      mkdir -p $jumpserver_backup/${app}_migrations
-      cp apps/${app}/migrations/*.py $jumpserver_backup/${app}_migrations
-   done
-
-
-3. 备份数据库，已被不时之需
+2. 备份数据库，已被不时之需
 
 ::
 
   $ mysqldump -u你的数据库账号 -h数据库地址 -p 数据库名称 > $jumpserver_backup/db_backup.sql
 
-4. 备份录像文件
+3. 切换分支或下载离线包, 更新代码
 
 ::
 
-   $ cp -r data/media $jumpserver_backup/
+   $ cd /opt
+   $ mv jumpserver jumpserver_bak
+   $ git clone https://github.com/jumpserver/jumpserver.git
+   $ cd jumpserver && git checkout master  # or other branch
+   $ git pull
 
-5. 切换分支或下载离线包, 更新代码
-
-::
-
-   $ git checkout master  # or other branch
-
-
-6. 还原配置文件
-
-::
-
-   $ cp $jumpserver_backup/config.py .
-
-7. 还原数据库表结构记录
-
-::
-
-   $ for app in common users assets ops perms terminal;do
-      cp $jumpserver_backup/${app}_migrations/*.py apps/${app}/migrations/
-   done
-
-8. 还原录像文件
+4. 还原录像文件
 
 ::
 
    $ cp -r $jumpserver_backup/media/* data/media/
 
-9. 更新依赖或表结构
+5. 更新依赖或表结构
 
 ::
 
@@ -143,5 +124,3 @@ coco是无状态的，备份 keys 目录即可
 **Guacamole**
 
 直接参考上面的升级即可, 需要注意的是如果更换机器，请备份
-
-

docs/upgrade.rst.orig

+更新升级
+-------------
+
+1. 升级 Jumpserver（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
+
+::
+
+    $ git pull && pip install -r requirements/requirements.txt && cd utils && sh make_migrations.sh
+
+    # 1.0.x 升级 1.2.0 需要执行迁移脚本（新版本授权管理更新）
+    $ sh 2018_04_11_migrate_permissions.sh
+ 
+2. 升级 Coco（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
+
+::
+
+<<<<<<< HEAD
+    $ git pull && pip install -r requirements/requirements.txt   # 不要指定 -i参数
+=======
+    $ git pull && cd requirements && pip install -r requirements.txt -i https://pypi.org/simple
+>>>>>>> upstream/docs
+
+3. 升级 Luna
+
+重新下载 release 包（https://github.com/jumpserver/luna/releases）
+
+4. 升级 guacamole
+
+::
+
+    $ docker pull registry.jumpserver.org/public/guacamole:latest
+    $ 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服务器的IP地址>:8080 \
+      registry.jumpserver.org/public/guacamole:latest
+
+    # 确定升级完成后，可以删除备份容器
+    $ docker rm jms_guacamole_bak
+
+
+切换分支或离线升级
+-------------------------------
+
+
+**Jumpserver**
+
+说明: 如果是新开的终端，别忘了 source /opt/py3/bin/activate
+
+1. 备份jumpserver
+
+::
+
+    $ jumpserver_backup=/tmp/jumpserver_backup
+    $ mkdir -p $jumpserver_backup
+    $ cd /opt/jumpservrer
+    $ cp -r ./ $jumpserver_backup
+
+2. 备份数据库，已被不时之需
+
+::
+
+  $ mysqldump -u你的数据库账号 -h数据库地址 -p 数据库名称 > $jumpserver_backup/db_backup.sql
+
+3. 切换分支或下载离线包, 更新代码
+
+::
+
+   $ cd /opt
+   $ mv jumpserver jumpserver_bak
+   $ git clone https://github.com/jumpserver/jumpserver.git
+   $ cd jumpserver && git checkout master  # or other branch
+   $ git pull
+
+4. 还原录像文件
+
+::
+
+   $ cp -r $jumpserver_backup/media/* data/media/
+
+5. 更新依赖或表结构
+
+::
+
+   $ pip install -r requirements/requirements.txt && cd utils && sh make_migrations.sh
+
+
+**Coco**
+
+说明: 以下操作都在 coco 项目所在目录
+
+coco是无状态的，备份 keys 目录即可
+
+1. 备份keys
+
+::
+
+   $ cp -r keys $jumpserver_backup/
+
+
+2. 离线更新升级coco（如果是新开的终端，别忘了 source /opt/py3/bin/activate）
+
+3. 还原 keys目录
+
+::
+
+   $ mv keys keys_backup
+   $ cp -r  $jumpserver_backup/keys .
+
+4. 升级依赖
+
+::
+
+   $ git pull && cd requirements && pip install -r requirements.txt
+
+
+**Luna**
+
+直接下载最新Release包替换即可
+
+
+**Guacamole**
+
+直接参考上面的升级即可, 需要注意的是如果更换机器，请备份