Merge pull request #1131 from wojiushixiaobai/docs

更改安装说明

docs/admin_create_asset.rst

@@ -147,7 +147,7 @@ Windows 生成 SSH 密钥可以参考（https://www.cnblogs.com/horanly/p/660410
 
     # 这里简单举几个例子
     Sudo /bin/su  # 当前系统用户可以免sudo密码执行sudo su命令（也就是可以直接切换到root，生产环境不建议这样操作）
-    Sodu /usr/bin/git,/usr/bin/php,/bin/cat,/bin/more,/bin/less,/usr/bin/head,/usr/bin/tail  # 当前系统用户可以免sudo密码执行git php cat more less head tail
+    Sudo /usr/bin/git,/usr/bin/php,/bin/cat,/bin/more,/bin/less,/usr/bin/head,/usr/bin/tail  # 当前系统用户可以免sudo密码执行git php cat more less head tail
 
     # 此处的权限应该根据使用用户的需求汇总后定制，原则上给予最小权限即可。
 

docs/admin_user.rst

@@ -36,7 +36,7 @@
 
 点击邮件中的设置密码链接，设置好密码后，您就可以用户名和密码登录 Jumpserver 了。
 
-用户首次登录 Junmpserver，会被要求完善用户信息。基本信息可以不变，但 SSH 密钥信息必须填上。
+用户首次登录 Jumpserver，会被要求完善用户信息。基本信息可以不变，但 SSH 密钥信息必须填上。
 
 Linux/Unix 生成 SSH 密钥可以参考（https://www.cnblogs.com/horanly/p/6604104.html)
 
@@ -91,4 +91,4 @@ Windows 生成 SSH 密钥可以参考（https://www.cnblogs.com/horanly/p/660410
 
 点击页面左侧“用户管理”菜单下的“登录日志”按钮，进入登录日志页面：
 
-.. image:: _static/img/admin_login_log.jpg
\ No newline at end of file
+.. image:: _static/img/admin_login_log.jpg

docs/faq.rst

@@ -22,7 +22,7 @@ FAQ
     (1). 这里解释一下系统用户里面的sudo，比如有个系统用户的权限是这样的：
 
     Sudo: /usr/bin/git,/usr/bin/php,/bin/cat,/bin/more,/bin/less,/usr/bin/head,/usr/bin/tail
-    意思是允许这个系统用户使用 git、PHP、cat、more、less、head、tail 命令，只要关联了这个系统用户的用户在相应的资产都可以执行这些命令。
+    意思是允许这个系统用户免密码执行 git、PHP、cat、more、less、head、tail 命令，只要关联了这个系统用户的用户在相应的资产都可以执行这些命令。
 
 3. coco或guacamole 注册失败，或重新注册方法
 
@@ -58,7 +58,7 @@ FAQ
        # 修改 /bin/yum 使用原来的python
        $ sed -i 's@/usr/bin/python$@/usr/bin/python2.4@g' /bin/yum
 
-5. input/output error, 通常jumpserver所在服务器字符集问题(一下修改方法仅限 centos7)
+5. input/output error, 通常jumpserver所在服务器字符集问题
 
 ::
 
@@ -72,6 +72,8 @@ FAQ
    $ export LC_ALL=zh_CN.UTF-8
    $ echo 'LANG=zh_CN.UTF-8' > /etc/sysconfig/i18n
 
+   如果任然报input/output error，尝试执行 yum update 后重启服务器（仅测试中参考使用，实际运营服务器请谨慎操作）
+
 6. 运行 sh make_migrations.sh 报错，
    CommandError: Conflicting migrations detected; multiple ... django_celery_beat ...
    这是由于 django-celery-beat老版本有bug引起的

docs/setup_by_ubuntu.rst

@@ -137,13 +137,10 @@
 
     $ cd /opt/jumpserver
     $ ./jms start all  # 后台运行使用 -d 参数./jms start all -d
-    
-    # 新版本更新了运行脚本，使用方式./jms start|stop|status|restart all  后台运行请添加 -d 参数
 
-运行不报错，请浏览器访问 http://192.168.244.144:8080/
-(这里只是 Jumpserver, 没有 Web Terminal，所以访问 Web Terminal 会报错)
+    # 新版本更新了运行脚本，使用方式./jms start|stop|status|restart all  后台运行请添加 -d 参数
 
-账号: admin 密码: admin
+运行不报错，请浏览器访问 http://192.168.244.144:8080/ 页面显示不正常先不用处理，能显示 jumpserver 页面即可继续往下操作
 
 三. 安装 SSH Server 和 WebSocket Server: Coco
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -171,12 +168,12 @@
 ::
 
     $ cd /opt/coco
-    $ cp conf_example.py conf.py
+    $ cp conf_example.py conf.py  # 如果 coco 与 jumpserver 分开部署，请手动修改 conf.py
     $ ./cocod start all  # 后台运行使用 -d 参数./cocod start -d
-    
+
     # 新版本更新了运行脚本，使用方式./cocod start|stop|status|restart 后台运行请添加 -d 参数
 
-这时需要去 Jumpserver 管理后台-会话管理-终端管理（http://192.168.244.144:8080/terminal/terminal/）接受 Coco 的注册
+后面设置好 nginx 后，记得去 Jumpserver 管理后台-会话管理-终端管理（http://192.168.244.144:8080/terminal/terminal/）接受 Coco 的注册
 
 ::
 
@@ -214,8 +211,8 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
     $ ls /opt/luna
     ...
 
-五. 安装 Windows 支持组件
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+五. 安装 Windows 支持组件（如果不需要管理 windows 资产，可以直接跳过这一步）
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 因为手动安装 guacamole 组件比较复杂，这里提供打包好的 docker 使用, 启动 guacamole
 
@@ -324,3 +321,10 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
 
 
 6.4 访问 http://192.168.244.144
+
+默认账号: admin 密码: admin
+
+到管理后台-会话管理-终端管理 接受 Coco Guacamole 等应用的注册
+
+后续的使用请参考 `快速入门 <admin_create_asset.html>`_
+如遇到问题可参考 `FAQ <faq.html>`_

docs/step_by_step.rst

@@ -24,6 +24,11 @@
     $ setenforce 0
     $ service iptables stop
 
+    # 修改字符集，否则可能报 input/output error的问题，因为日志里打印了中文
+    $ localedef -c -f UTF-8 -i zh_CN zh_CN.UTF-8
+    $ export LC_ALL=zh_CN.UTF-8
+    $ echo 'LANG=zh_CN.UTF-8' > /etc/sysconfig/i18n
+
 一. 准备 Python3 和 Python 虚拟环境
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -160,22 +165,16 @@ Pip 加速设置请参考 <https://segmentfault.com/a/1190000011875306>
 
     $ cd /opt/jumpserver
     $ ./jms start all  # 后台运行使用 -d 参数./jms start all -d
-    
-    # 新版本更新了运行脚本，使用方式./jms start|stop|status|restart all  后台运行请添加 -d 参数
 
-运行不报错，请浏览器访问 http://192.168.244.144:8080/
-注意：这里只是 Jumpserver, 没有 Web Terminal，所以访问 Web Terminal 会报错。如果不能访问请检查主机8080端口号是否能访问，AWS 的 EC2 的80、8080端口受到限制，需要 ICP 备案才可以开放，遇到这种情况，可到 config.py 文件里修改 Jumpserver 端口为8888。
+    # 新版本更新了运行脚本，使用方式./jms start|stop|status|restart all  后台运行请添加 -d 参数
 
-账号: admin 密码: admin
+运行不报错，请浏览器访问 http://192.168.244.144:8080/ 页面显示不正常先不用处理，需要搭建 nginx 代理就可以正常访问了
 
-附上重启的方法(这里待优化)
+附上重启的方法
 
 ::
 
-    $ ps axu | egrep '(gunicorn|celery|beat)'
-    $ ps axu | egrep '(gunicorn|celery|beat)' | awk '{ print $2 }' | xargs kill -9
-
-
+    $ ./jms restart
 
 三. 安装 SSH Server 和 WebSocket Server: Coco
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -204,12 +203,12 @@ Pip 加速设置请参考 <https://segmentfault.com/a/1190000011875306>
 ::
 
     $ cd /opt/coco
-    $ cp conf_example.py conf.py
+    $ cp conf_example.py conf.py  # 如果 coco 与 jumpserver 分开部署，请手动修改 conf.py
     $ ./cocod start  # 后台运行使用 -d 参数./cocod start -d
-    
+
     # 新版本更新了运行脚本，使用方式./cocod start|stop|status|restart  后台运行请添加 -d 参数
 
-这时需要去 Jumpserver 管理后台-会话管理-终端管理（http://192.168.244.144:8080/terminal/terminal/）接受 Coco 的注册
+后面设置好 nginx 后，记得去 Jumpserver 管理后台-会话管理-终端管理（http://192.168.244.144:8080/terminal/terminal/）接受 Coco 的注册
 
 ::
 
@@ -248,8 +247,8 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
     $ ls /opt/luna
     ...
 
-五. 安装 Windows 支持组件
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+五. 安装 Windows 支持组件（如果不需要管理 windows 资产，可以直接跳过这一步）
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 因为手动安装 guacamole 组件比较复杂，这里提供打包好的 docker 使用, 启动 guacamole
 
@@ -260,14 +259,13 @@ Luna 已改为纯前端，需要 Nginx 来运行访问
     $ yum remove docker-latest-logrotate  docker-logrotate  docker-selinux dockdocker-engine
     $ yum install docker-ce
     $ yum install -y yum-utils   device-mapper-persistent-data   lvm2
-    $
+
     $ yum-config-manager     --add-repo     https://download.docker.com/linux/centos/docker-ce.repo
     $ yum-config-manager --enable docker-ce-edge
     $ yum-config-manager --enable docker-ce-test
     $ yum-config-manager --disable docker-ce-edge
     $ yum install docker-ce
-    $
-    $ systemctl status docker
+
     $ systemctl start docker
     $ systemctl status docker
 
@@ -375,3 +373,10 @@ Jumpserver 会话管理-终端管理（http://192.168.244.144:8080/terminal/term
 
 
 6.4 访问 http://192.168.244.144
+
+默认账号: admin 密码: admin
+
+到管理后台-会话管理-终端管理 接受 Coco Guacamole 等应用的注册
+
+后续的使用请参考 `快速入门 <admin_create_asset.html>`_
+如遇到问题可参考 `FAQ <faq.html>`_