Merge pull request #2729 from wojiushixiaobai/docs

[Update]更新文档

docs/distributed_01.rst

@@ -5,7 +5,7 @@
 ~~~~~~~
 
 -  系统: CentOS 7
--  数据库 IP: 192.168.100.10
+-  数据库 IP: 192.168.100.10 192.168.100.11 192.168.100.12
 -  Redis ip: 192.168.100.20
 -  Jumpserver IP: 192.168.100.30
 -  Coco IP: 192.168.100.40

docs/migration.rst

@@ -2,7 +2,7 @@
 -------------
 
 对 Jumpserver 服务进行迁移, 只需要备份 "数据库" 和 "jumpserver目录" 即可
-注：1.4.5及之后的版本迁移, 只需要迁移 "数据库" "配置文件" 和 "录像目录"
+注：1.4.5 及之后的版本迁移, 只需要迁移 "数据库" "配置文件" 和 "录像目录"
 
 1. 备份数据到新的服务器
 
@@ -17,12 +17,7 @@
 
 .. code-block:: shell
 
-    $ 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/locale.conf
-
     $ yum -y install wget gcc epel-release git
-
     $ yum -y install mariadb mariadb-devel mariadb-server
     $ yum -y install redis
 

docs/setup_by_prod.rst

@@ -3,16 +3,16 @@
 
 组件说明
 ~~~~~~~~~~~~~~
-- Jumpserver 为管理后台, 管理员可以通过Web页面进行资产管理、用户管理、资产授权等操作
-- Coco 为 SSH Server 和 Web Terminal Server 。用户可以通过使用自己的账户登录 SSH 或者 Web Terminal 直接访问被授权的资产。不需要知道服务器的账户密码
+- Jumpserver 为管理后台, 管理员可以通过 Web 页面进行资产管理、用户管理、资产授权等操作, 用户可以通过 Web 页面进行资产登录, 文件管理等操作
+- Coco 为 SSH Server 和 Web Terminal Server 。用户可以使用自己的账户通过 SSH 或者 Web Terminal 访问 SSH 协议和 Telnet 协议资产
 - Luna 为 Web Terminal Server 前端页面, 用户使用 Web Terminal 方式登录所需要的组件
-- Guacamole 为 Windows 组件, 用户可以通过 Web Terminal 来连接 Windows 资产 (暂时只能通过 Web Terminal 来访问)
+- Guacamole 为 RDP 协议和 VNC 协议资产组件, 用户可以通过 Web Terminal 来连接 RDP 协议和 VNC 协议资产 (暂时只能通过 Web Terminal 来访问)
 
 端口说明
 ~~~~~~~~~~~~~~
-- Jumpserver 默认端口为 8080/tcp 配置文件在 jumpserver/config.yml
+- Jumpserver 默认端口为 8080/tcp 配置文件 jumpserver/config.yml
 - Coco 默认 SSH 端口为 2222/tcp, 默认 Web Terminal 端口为 5000/tcp 配置文件在 coco/config.yml
-- Guacamole 默认端口为 8081/tcp
+- Guacamole 默认端口为 8081/tcp, 配置文件 /config/tomcat8/conf/server.xml
 - Nginx 默认端口为 80/tcp
 - Redis 默认端口为 6379/tcp
 - Mysql 默认端口为 3306/tcp

docs/step_by_step.rst

@@ -13,3 +13,4 @@
    start_automatically
    upgrade
    migration
+   uninstall

docs/uninstall.rst

+卸载文档
+-------------
+
+说明
+~~~~~~~
+
+- 确保已经停止 jms coco guacamole 进程
+- 确定数据已经处理完毕
+- 此操作不可逆
+- 请自行替换文中相关路径为你的实际环境路径
+
+1. 参照一步一步安装文档进行安装的使用下面方式进行卸载
+
+.. code-block:: shell
+
+    $ rm -rf /opt/jumpserver  # jumpserver 目录
+    $ rm -rf /opt/coco  # coco 目录
+    $ rm -rf /opt/docker-guacamole  # guacamole 目录
+    $ rm -rf /opt/py3  # python3 虚拟环境
+    $ rm -rf /config  # guacamole 目录
+    $ rm -rf /opt/luna  # luna 目录
+    $ rm -rf /etc/init.d/guacd
+    $ rm -rf /bin/ssh-forward
+    $ rm -rf /etc/nginx/conf.d/jumpserver.conf
+
+    # 删除自启文件
+    $ rm -rf /usr/lib/systemd/system/jms.service
+    $ rm -rf /usr/lib/systemd/system/coco.service
+    $ rm -rf /usr/lib/systemd/system/guacamole.service
+
+    # 删除数据库
+    $ mysql -uroot
+    > drop database jumpserver;
+    > exit
+
+    # 清空 redis
+    $ redis-cli -h 127.0.0.1
+    > flushall
+    > exit
+
+    $ reboot # 重启服务器
+
+2. 参照极速安装或者使用 docker 部署组件的使用下面方式进行卸载
+
+.. code-block:: shell
+
+    $ rm -rf /opt/jumpserver  # jumpserver 目录
+    $ rm -rf /opt/py3  # python3 虚拟环境
+    $ rm -rf /etc/nginx/conf.d/jumpserver.conf
+
+    # 删除 docker 组件
+    $ docker rm jms_coco
+    $ docker rm jms_guacamole
+    $ docker rmi jumpserver/jms_coco:1.4.10  # 自行替换版本
+    $ docker rmi jumpserver/jms_guacamole:1.4.10  # 自行替换版本
+
+    # 删除自启文件
+    $ rm -rf /usr/lib/systemd/system/jms.service
+    $ rm -rf /opt/start_jms.sh
+    $ rm -rf /opt/stop_jms.sh
+
+    # 删除数据库
+    $ mysql -uroot
+    > drop database jumpserver;
+    > exit
+
+    # 清空 redis
+    $ redis-cli -h 127.0.0.1
+    > flushall
+    > exit
+
+    $ reboot # 重启服务器