Merge pull request #2037 from wojiushixiaobai/docs

[Update]更新文档

docs/admin_create_asset.rst

@@ -112,7 +112,7 @@
 
     (3). 打开RSA验证相关设置
 
-      $ vim /etc/ssh/sshd_config
+      $ vi /etc/ssh/sshd_config
 
       RSAAuthentication yes
       PubkeyAuthentication yes

docs/distributed_05.rst

@@ -145,7 +145,7 @@
 .. code-block:: nginx
 
     # 修改 nginx 配置文件(如果无法正常访问,请注释掉 nginx.conf 的 server 所有字段)
-    $ vim /etc/nginx/conf.d/jumpserver.conf
+    $ vi /etc/nginx/conf.d/jumpserver.conf
 
     server {
         listen 80;

docs/faq.rst

@@ -82,7 +82,7 @@ FAQ
 
 .. code-block:: shell
 
-    $ vim /opt/coco/conf.py
+    $ vi /opt/coco/conf.py
 
     # 把 SSH_TIMEOUT = 15 修改成你想要的数字 单位为：秒
     SSH_TIMEOUT = 60
@@ -108,7 +108,7 @@ FAQ
 
 .. code-block:: shell
 
-    $ vim /opt/jumpserver/apps/jumpserver/settings.py
+    $ vi /opt/jumpserver/apps/jumpserver/settings.py
 
 .. code-block:: python
 
@@ -141,7 +141,7 @@ FAQ
     # 具体表现为在luna页面一会可以连接资产,一会就不行,需要多次刷新页面
     # 如果从开发者工具里面看,可以看到部分不正常的 502 socket.io
     # 此问题一般是由最前端一层的nginx反向代理造成的,需要在每层的代理上添加(注意是每层)
-    $ vim /etc/nginx/conf.d/jumpserver.conf  # 配置文件所在目录,自行修改
+    $ vi /etc/nginx/conf.d/jumpserver.conf  # 配置文件所在目录,自行修改
 
     ...  # 省略
 
@@ -171,7 +171,7 @@ FAQ
     ...
 
     # 为了便于理解,附上一份 demo 网站的配置文件参考
-    $ vim /etc/nginx/conf.d/jumpserver.conf
+    $ vi /etc/nginx/conf.d/jumpserver.conf
     server {
 
         listen 80;

docs/faq_install.rst

@@ -120,7 +120,7 @@
 
     这是因为当前系统的 hostname 有 coco 不支持的字符,需要手动指定 coco 的 NAME
     $ cd /opt/coco/
-    $ vim conf.py
+    $ vi conf.py
 
     # 项目名称, 会用来向Jumpserver注册, 识别而已, 不能重复
     # NAME = "localhost"
@@ -156,7 +156,7 @@
 .. code-block:: nginx
 
     这是因为你没有按照教程进行安装,修改了安装目录,需要在 nginx 的配置文件里面修改资源路径
-    $ vim /etc/nginx/conf.d/jumpserver.conf
+    $ vi /etc/nginx/conf.d/jumpserver.conf
 
     ...
 

docs/faq_sftp.rst

@@ -17,7 +17,7 @@ sftp 使用说明
     # 此处即是当前资产的 home 目录
 
     # 如果需要修改 /tmp 为其他目录
-    $ vim coco/coco/sftp.py
+    $ vi coco/coco/sftp.py
 
 .. code-block:: python
 

docs/faq_ssh.rst

@@ -81,7 +81,7 @@ SSH 协议资产连接错误排查思路
 
     # 这是因为当前系统的 hostname 有 coco 不支持的字符,需要手动指定 coco 的 NAME
     $ cd /opt/coco/
-    $ vim conf.py
+    $ vi conf.py
 
     # 项目名称, 会用来向Jumpserver注册, 识别而已, 不能重复
     # NAME = "localhost"

docs/setup_by_optimization.rst

@@ -9,7 +9,7 @@
 ::
 
     $ cd /opt/jumpserver
-    $ vim config.py
+    $ vi config.py
 
     # 调整 debug 模式和 log_level
     ...
@@ -20,7 +20,7 @@
 
 
     $ cd /opt/coco
-    $ vim conf.py
+    $ vi conf.py
 
     # 调整 log_level
     ...
@@ -42,7 +42,7 @@
 
     # 在最前端的 nginx 代理服务器上进行设置
     $ cd /etc/nginx
-    $ vim conf.d/jumpserver.conf
+    $ vi conf.d/jumpserver.conf
 
     ...
     # 根据自己的 OSS 所在地域和 域名,自行替换 yourBucket 和 yourEndPoint

docs/setup_by_ubuntu.rst

@@ -261,7 +261,7 @@
     $ cd /opt/coco
     $ mkdir keys logs
     $ cp conf_example.py conf.py  # 如果 coco 与 jumpserver 分开部署,请手动修改 conf.py
-    $ vi conf.py
+    $ vim conf.py
 
     # 注意对齐,不要直接复制本文档的内容,实际内容以文件为准,本文仅供参考
 
@@ -469,7 +469,7 @@ Luna 已改为纯前端,需要 Nginx 来运行访问
 
 .. code-block:: nginx
 
-    $ vi /etc/nginx/site-enabled/default
+    $ vim /etc/nginx/site-enabled/default
 
     server {
         listen 80;

docs/upgrade.rst

@@ -11,7 +11,7 @@
 
 0. 检查数据库表结构文件是否完整
 
-::
+.. code-block:: shell
 
     # 为了保证能顺利升级,请先检查数据库表结构文件是否完整
     $ cd /opt/jumpserver/apps
@@ -26,7 +26,7 @@
 
 1. 备份 Jumpserver 数据库表结构 (通过releases包升级需要还原这些文件)
 
-::
+.. code-block:: shell
 
     $ jumpserver_backup=/tmp/jumpserver_backup
     $ mkdir -p $jumpserver_backup
@@ -38,6 +38,8 @@
         fi
       done
 
+.. code-block:: shell
+
     # 还原代码 (通过releases包升级需要还原这些文件,通过git pull升级不需要执行)
     $ cd $jumpserver_backup/
     $ for d in $(ls);do
@@ -48,7 +50,7 @@
 
 2. 升级 Jumpserver
 
-::
+.. code-block:: shell
 
     # 升级前请做好 jumpserver 与 数据库 备份,谨防意外,具体的备份命令可以参考离线升级
     $ cd /opt/jumpserver
@@ -56,32 +58,47 @@
     $ git pull
     $ ./jms stop
 
+.. code-block:: shell
+
     # jumpserver 版本小于 1.3 升级到最新版本请使用新的 config.py (升级前版本小于 1.3 需要执行此步骤,否则跳过)
     $ mv config.py config.bak
     $ cp config_example.py config.py
-    $ vim config.py  # 参考安装文档进行修改
+    $ vi config.py  # 参考安装文档进行修改
+
+.. code-block:: shell
 
     # 所有版本都需要执行此步骤
     $ pip install -r requirements/requirements.txt
     $ cd utils && sh make_migrations.sh
 
+.. code-block:: shell
+
     # 如果执行 sh make_migrations.sh 时有红色文字提示 Run 'manage.py make_migrations' 和 'manage.py migrate' ,则需要执行下面4条命令,没有则忽略这一步
     $ cd /opt/jumpserver/apps
     $ python manage.py makemigrations
     $ python manage.py migrate
     $ cd ../utils && sh make_migrations.sh
 
+.. code-block:: shell
+
     # 1.0.x 升级到最新版本需要执行迁移脚本 (新版本授权管理更新,升级前版本不是 1.0.x 请跳过)
     $ sh 2018_04_11_migrate_permissions.sh
 
+.. code-block:: shell
+
     # 任意版本升级到 1.4.0 版本,需要执行(升级前版本小于 1.4.0 需要执行此步骤)
     $ sh 2018_07_15_set_win_protocol_to_ssh.sh
 
+.. code-block:: shell
+
     # 启动 jumpserver
-    $ cd ../ && ./jms start all
+    $ cd ../
+    $ ./jms start all
+
+.. code-block:: vim
 
     # 任意版本升级到 1.4.2 版本,需要修改 nginx 配置 (升级前版本小于 1.4.2 需要执行此步骤)
-    $ vim /etc/nginx/conf.d/jumpserver.conf  # 部分用户的配置文件是/etc/nginx/nginx.conf
+    $ vi /etc/nginx/conf.d/jumpserver.conf  # 部分用户的配置文件是/etc/nginx/nginx.conf
 
     ...
 
@@ -105,12 +122,14 @@
 
     ...
 
+.. code-block:: shell
+
     # 保存后重新载入配置
     $ nginx -s reload
 
 3. 升级 Coco (docker 部署的请忽略往下看)
 
-::
+.. code-block:: shell
 
     # 如果 coco 目录非默认位置请手动修改
     $ cd /opt/coco
@@ -119,16 +138,18 @@
     $ ./cocod stop
     $ pip install -r requirements/requirements.txt
 
+.. code-block:: shell
+
     # coco 升级前版本小于 1.4.1 升级到最新版本请使用新的 conf.py (升级前版本小于 1.4.1 需要执行此步骤)
     $ mv conf.py coco.bak
     $ cp conf_example.py conf.py
-    $ vim conf.py  # 参考安装文档进行修改
+    $ vi conf.py  # 参考安装文档进行修改
 
     $ ./cocod start
 
 4. 升级 guacamole (docker 部署的请忽略往下看)
 
-::
+.. code-block:: shell
 
     $ cd /opt/docker-guacamole
     $ git pull
@@ -148,7 +169,7 @@
 
 重新下载 release 包(https://github.com/jumpserver/luna/releases)
 
-::
+.. code-block:: shell
 
     $ cd /opt
     $ rm -rf luna
@@ -160,7 +181,7 @@
 
 6. Docker 部署 coco guacamole 升级说明
 
-::
+.. code-block:: shell
 
     # 先到 Web 会话管理 - 终端管理 删掉所有组件
     $ docker sop jms_coco
@@ -183,7 +204,7 @@
 
 **Jumpserver**
 
-::
+.. code-block:: shell
 
     $ cd /opt/jumpserver
     $ git pull
@@ -204,24 +225,20 @@
 
 说明: Docker 部署的请跳过
 
-::
+.. code-block:: shell
 
     $ cd /opt/coco
     $ git pull
     $ source /opt/py3/bin/activate
     $ ./cocod stop
-
-
     $ pip install -r requirements/requirements.txt
-
     $ ./cocod start
 
-
 **Guacamole**
 
 说明: Docker 部署的请跳过
 
-::
+.. code-block:: shell
 
     $ cd /opt/docker-guacamole
     $ git pull
@@ -241,7 +258,7 @@
 
 说明: 直接下载 release 包
 
-::
+.. code-block:: shell
 
     $ cd /opt
     $ rm -rf luna
@@ -253,7 +270,7 @@
 
 说明: Docker 部署的 coco 与 guacamole 升级说明
 
-::
+.. code-block:: shell
 
     # 先到 Web 会话管理 - 终端管理 删掉所有组件
     $ docker sop jms_coco

docs/user_api.rst

@@ -6,7 +6,7 @@ API 文档
     通过访问 http://Jumpserver的URL地址/docs 来访问( 如 http://192.168.244.144/docs )
     注：需要打开 debug 模式,
 
-    $ vim jumpserver/config.py
+    $ vi jumpserver/config.py
 
     ...
     Debug=True