Merge pull request #2198 from wojiushixiaobai/docs

[Update]Docs

docs/distributed_06.rst

@@ -48,7 +48,7 @@
         -p 5000:5000 \
         -e CORE_HOST=http://192.168.100.30:8080 \
         -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV \
-        wojiushixiaobai/coco:1.4.5
+        jumpserver/jms_coco:1.4.5
 
     # 访问 http://192.168.100.100/terminal/terminal/ 检查 coco 注册
 
@@ -67,6 +67,6 @@
         -p 5001:5000 \
         -e CORE_HOST=http://192.168.100.30:8080 \
         -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV \
-        wojiushixiaobai/coco:1.4.5
+        jumpserver/jms_coco:1.4.5
 
     # 访问 http://192.168.100.100/terminal/terminal/ 检查 coco 注册

docs/distributed_07.rst

@@ -48,7 +48,7 @@
         -e JUMPSERVER_KEY_DIR=/config/guacamole/key \
         -e JUMPSERVER_SERVER=http://192.168.100.30:8080 \
         -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV \
-        wojiushixiaobai/guacamole:1.4.5
+        jumpserver/jms_guacamole:1.4.5
 
     # 访问 http://192.168.100.100/terminal/terminal/ 检查 guacamole 注册
 
@@ -65,6 +65,6 @@
         -e JUMPSERVER_KEY_DIR=/config/guacamole/key \
         -e JUMPSERVER_SERVER=http://192.168.100.30:8080 \
         -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV \
-        wojiushixiaobai/guacamole:1.4.5
+        jumpserver/jms_guacamole:1.4.5
 
     # 访问 http://192.168.100.100/terminal/terminal/ 检查 guacamole 注册

docs/dockerinstall.rst

@@ -15,7 +15,7 @@ Docker 安装见: `Docker官方安装文档 <https://docs.docker.com/install/>`_
 .. code-block:: shell
 
     # 1.4.5 版本(最新)
-    $ docker run --name jms_server -d -p 80:80 -p 2222:2222 wojiushixiaobai/jumpserver:latest
+    $ docker run --name jms_server -d -p 80:80 -p 2222:2222 jumpserver/jms_all:latest
 
 访问
 ```````````````
@@ -80,7 +80,7 @@ XShell等工具请添加connection连接,ssh 端口 2222
         -e REDIS_HOST=192.168.x.x \
         -e REDIS_PORT=6379 \
         -e REDIS_PASSWORD=xxx \
-        wojiushixiaobai/jumpserver:latest
+        jumpserver/jms_all:latest
 
 仓库地址
 ```````````````

docs/faq_docker.rst

@@ -96,6 +96,6 @@ Docker 使用说明
     $ docker pull <镜像地址:版本>
 
     # 例:
-    $ docker pull wojiushixiaobai/jumpserver:latest
-    $ docker pull wojiushixiaobai/coco:1.4.5
-    $ docker pull wojiushixiaobai/guacamole:1.4.5
+    $ docker pull jumpserver/jms_all:latest
+    $ docker pull jumpserver/jms_coco:1.4.5
+    $ docker pull jumpserver/jms_guacamole:1.4.5

docs/faq_rdp.rst

@@ -35,7 +35,7 @@ RDP 协议资产连接错误排查思路
     # docker 部署请直接删除容器后重建,记得一定要先在 终端管理 删除不在线的组件
     $ docker stop jms_guacamole
     $ docker rm jms_guacamole
-    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV wojiushixiaobai/guacamole:1.4.5
+    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV jumpserver/jms_guacamole:1.4.5
 
     # 正常运行后到Jumpserver 会话管理-终端管理 里面接受gua注册
 

docs/faq_ssh.rst

@@ -32,7 +32,7 @@ SSH 协议资产连接错误排查思路
     # docker 部署请直接删除容器后重建,记得一定要先在 终端管理 删除不在线的组件
     $ docker stop jms_coco
     $ docker rm jms_coco
-    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV wojiushixiaobai/coco:1.4.5
+    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV jumpserver/jms_coco:1.4.5
 
     # 正常运行后到Jumpserver 会话管理-终端管理 里面接受coco注册
 

docs/setup_by_centos7.rst

@@ -251,8 +251,8 @@ CentOS 7 安装文档
     $ systemctl restart docker
 
     # 注意,<Jumpserver_url> 请自行修改成 jumpserver 对外的访问地址,如 192.168.100.100:8080
-    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV wojiushixiaobai/coco:1.4.5
-    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV wojiushixiaobai/guacamole:1.4.5
+    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV jumpserver/jms_coco:1.4.5
+    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV jumpserver/jms_guacamole:1.4.5
 
     # 允许 容器ip 访问宿主 8080 端口,(容器的 ip 可以进入容器查看)
     $ firewall-cmd --permanent --add-rich-rule="rule family="ipv4" source address="172.17.0.2" port protocol="tcp" port="8080" accept"
@@ -366,13 +366,13 @@ CentOS 7 安装文档
 .. code-block:: shell
 
     # coco 服务默认运行在单核心下面, 当负载过高时会导致用户访问变慢, 这时可运行多个 docker 容器缓解
-    $ docker run --name jms_coco01 -d -p 2223:2222 -p 5001:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV wojiushixiaobai/coco:1.4.5
-    $ docker run --name jms_coco02 -d -p 2224:2222 -p 5002:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV wojiushixiaobai/coco:1.4.5
+    $ docker run --name jms_coco01 -d -p 2223:2222 -p 5001:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV jumpserver/jms_coco:1.4.5
+    $ docker run --name jms_coco02 -d -p 2224:2222 -p 5002:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV jumpserver/jms_coco:1.4.5
     ...
 
     # guacamole 也是一样
-    $ docker run --name jms_guacamole01 -d -p 8082:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV wojiushixiaobai/guacamole:1.4.5
-    $ docker run --name jms_guacamole02 -d -p 8083:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV wojiushixiaobai/guacamole:1.4.5
+    $ docker run --name jms_guacamole01 -d -p 8082:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV jumpserver/jms_guacamole:1.4.5
+    $ docker run --name jms_guacamole02 -d -p 8083:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV jumpserver/jms_guacamole:1.4.5
     ...
 
     # 注意开放防火墙, ip 请根据实际情况修改

docs/upgrade.rst

@@ -383,10 +383,10 @@
     $ docker stop jms_guacamole
     $ docker rm jms_coco
     $ docker rm jms_guacamole
-    $ docker pull wojiushixiaobai/coco:1.4.4
-    $ docker pull wojiushixiaobai/guacamole:1.4.4
-    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> wojiushixiaobai/coco:1.4.4
-    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> wojiushixiaobai/guacamole:1.4.4
+    $ docker pull jumpserver/jms_coco:1.4.4
+    $ docker pull jumpserver/jms_guacamole:1.4.4
+    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> jumpserver/jms_coco:1.4.4
+    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> jumpserver/jms_guacamole:1.4.4
 
     # 到 Web 会话管理 - 终端管理 接受新的注册
 
@@ -740,10 +740,10 @@
     $ docker stop jms_guacamole
     $ docker rm jms_coco
     $ docker rm jms_guacamole
-    $ docker pull wojiushixiaobai/coco:1.4.5
-    $ docker pull wojiushixiaobai/guacamole:1.4.5
-    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV wojiushixiaobai/coco:1.4.5
-    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV wojiushixiaobai/guacamole:1.4.5
+    $ docker pull jumpserver/jms_coco:1.4.5
+    $ docker pull jumpserver/jms_guacamole:1.4.5
+    $ docker run --name jms_coco -d -p 2222:2222 -p 5000:5000 -e CORE_HOST=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV jumpserver/jms_coco:1.4.5
+    $ docker run --name jms_guacamole -d -p 8081:8081 -e JUMPSERVER_SERVER=http://<Jumpserver_url> -e BOOTSTRAP_TOKEN=nwv4RdXpM82LtSvmV jumpserver/jms_guacamole:1.4.5
 
     # 到 Web 会话管理 - 终端管理 查看组件是否已经在线
 

docs/user_api.rst

@@ -17,7 +17,11 @@ API 文档
 .. code-block:: shell
 
     $ curl -X POST -H 'Content-Type: application/json' -d '{"username": "admin", "password": "admin"}' http://localhost/api/users/v1/auth/  # 获取token
-    {"Token":"937b38011acf499eb474e2fecb424ab3"}%  # 获取到的token
+    {"token":"937b38011acf499eb474e2fecb424ab3"}%  # 获取到的token
+
+    # 如果开启了 MFA, 则返回的是 seed, 需要携带 seed 和 otp_code 再次提交一次才能获取到 token
+    $ curl -X POST  -H 'Content-Type: application/json' -H 'cache-control: no-cache' -d '{"seed": "629ba0935a624bd9b21e31c19e0cc8cb", "otp_code": "202123"}'
+    {"token":"937b38011acf499eb474e2fecb424ab3"}%
 
     $ curl -H 'Authorization: Bearer 937b38011acf499eb474e2fecb424ab3' -H "Content-Type:application/json" http://localhost/api/users/v1/users/
     # 使用token访问,token有效期 1小时