diff --git a/docs/admin_guide.rst b/docs/admin_guide.rst index b6641a2da..fd770c17c 100644 --- a/docs/admin_guide.rst +++ b/docs/admin_guide.rst @@ -9,3 +9,7 @@ admin_instruction admin_user admin_asset + admin_permission + admin_work_center + admin_session + admin_system_settings diff --git a/docs/admin_permission.rst b/docs/admin_permission.rst index a506aa8d3..0bd5c3bde 100644 --- a/docs/admin_permission.rst +++ b/docs/admin_permission.rst @@ -1,9 +1,9 @@ -权限管理 -========= +权限管理模块 +============= 这里介绍权限管理功能。 .. toctree:: :maxdepth: 1 - permission_asset_authorized \ No newline at end of file + permission_asset_authorized diff --git a/docs/admin_session.rst b/docs/admin_session.rst new file mode 100644 index 000000000..90b38e4e8 --- /dev/null +++ b/docs/admin_session.rst @@ -0,0 +1,13 @@ +会话管理模块 +============== + +这里介绍会话管理功能。 + +.. toctree:: + :maxdepth: 1 + + session_history + session_online + session_command + session_web_terminal + session_terminal \ No newline at end of file diff --git a/docs/admin_system_settings.rst b/docs/admin_system_settings.rst new file mode 100644 index 000000000..eca804a62 --- /dev/null +++ b/docs/admin_system_settings.rst @@ -0,0 +1,41 @@ +系统设置 +============= + +这里介绍系统设置的功能。 + +.. contents:: Topics + +.. _view_system_settings: + +查看系统设置 +````````````` + +点击页面左侧“系统设置”按钮，进入系统设置页面，产看基本设置、邮件设置、LDAP 设置和终端设置等内容。 + +.. _basic_settings: + +基本设置 +````````` + +点击页面上边的“基本设置“ TAB ，进入基本设置页面，编辑当前站点 URL、用户想到 URL、Email 主题前缀等信息，点击“提交”按钮，基本设置完成。 + +.. _email_settings: + +邮件设置 +````````` + +点击页面上边的“邮件设置” TAB ，进入邮件设置页面，编辑 SMTP 主机、SMTP 端口、SMTP 账号、SMTP 密码和使用 SSL 或者 TSL 等信息，点击“测试连接”按钮，测试是否正确设置，点击“提交”按钮，邮件设置完成。 + +.. _ladp_settings: + +LDAP 设置 +```````````` + +点击页面上边的“ LDAP 设置” TAB ，进入 LDAP 设置页面，编辑 LDAP 地址、DN、用户 OU、用户过滤器、LDAP 属性映射和是否使用 SSL、是否启用 LDAP 认证等信息，点击“测试连接”按钮，测试是否正确设置，点击“提交”按钮，完成 LDAP 设置。 + +.. _terminal_settings: + +终端设置 +```````````` + +点击页面上边的“终端设置” TAB ，进入终端设置页面，编辑终端信息，点击“提交”按钮，终端设置完成。 \ No newline at end of file diff --git a/docs/admin_work_center.rst b/docs/admin_work_center.rst index 7fc0f828a..a15e2095c 100644 --- a/docs/admin_work_center.rst +++ b/docs/admin_work_center.rst @@ -1,5 +1,5 @@ -作业中心 -========= +作业中心模块 +============== 这里介绍作业中心功能。 diff --git a/docs/asset_label.rst b/docs/asset_label.rst index 43ecf59e3..abc723df3 100644 --- a/docs/asset_label.rst +++ b/docs/asset_label.rst @@ -1,2 +1,34 @@ 标签管理 -============ \ No newline at end of file +============ + +这里介绍标签管理的功能。 + +.. contents:: Topics + +.. _view_label_list: + +查看标签列表 +```````````````` + +点击页面左边“资产管理”菜单下的“标签管理”按钮，进入标签列表页面，产看标签的名称、值、资产数等信息。 + +.. _create_label: + +创建标签 +```````````` + +点击页面左上角“创建标签”按钮，进入创建标签页面，填写标签的名称、值等信息，选择资产，点击“提交”按钮，标签创建完成。 + +.. _update_label: + +更新标签 +```````````` + +点击页面右边动作栏的“更新”按钮，进入更新标签页面，编辑标签信息，点击“提交”按钮，标签更新完成。 + +.. _delete_label: + +删除标签 +````````` + +点击页面右边动作栏的“删除”按钮，弹出删除确认框，点击“确认”按钮，完成标签删除。 \ No newline at end of file diff --git a/docs/permission_asset_authorized.rst b/docs/permission_asset_authorized.rst index a9503e473..70e109b26 100644 --- a/docs/permission_asset_authorized.rst +++ b/docs/permission_asset_authorized.rst @@ -1,4 +1,4 @@ -个人资产 +资产授权 ========= 这里介绍资产授权的相关的功能。 diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 7892999fe..7e391b11f 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -13,7 +13,7 @@ Docker 安装见: `Docker官方安装文档 `_ ``````````````` 使用root命令行输入:: - $ docker run -p 8080:80 -p 2222:2222 jumpserver/jumpserver:0.5.0-beta2 + $ docker run -d -p 8080:80 -p 2222:2222 registry.jumpserver.org/public/jumpserver:latest 访问 ``````````````` @@ -39,7 +39,7 @@ ssh访问: ssh -p 2222 localhost :: - docker run -p 8080:80 -p 2222:2222 -e DB_ENGINE=mysql -e DB_HOST=192.168.1.1 -e DB_PORT=3306 -e DB_USER=root -e DB_PASSWORD=xxx -e DB_NAME=jumpserver jumpserver/jumpserver:0.5.0-beta2 + docker run -d -p 8080:80 -p 2222:2222 -e DB_ENGINE=mysql -e DB_HOST=192.168.1.1 -e DB_PORT=3306 -e DB_USER=root -e DB_PASSWORD=xxx -e DB_NAME=jumpserver registry.jumpserver.org/public/jumpserver:latest 仓库地址 diff --git a/docs/session_command.rst b/docs/session_command.rst new file mode 100644 index 000000000..a1296f86f --- /dev/null +++ b/docs/session_command.rst @@ -0,0 +1,30 @@ +命令记录 +========= + +这里介绍命令记录功能。 + +点击页面左侧“会话管理”菜单下的“命令记录”，进入命令记录列表页面。 + +.. contents:: Topics + +.. _view_command_session: + +查看命令记录 +````````````` + +命令记录页面默认展示一周内命令记录，页面左上角提供起止时间、用户、资产、系统用户等搜索过滤条件。 + +.. _detial_command_invoke: + +查看命令执行详情 +```````````````` + +点击命令记录列表中需要查看命令执行详情的行，即可显示命令执行详情。 + +.. _detial_command_session: + +转到会话详情 +````````````` + +在命令记录列表中找到需要转到会话详情的记录，点击“会话”标题下的“转到”按钮，完成转到会话详情。 + diff --git a/docs/session_history.rst b/docs/session_history.rst new file mode 100644 index 000000000..c4b63231f --- /dev/null +++ b/docs/session_history.rst @@ -0,0 +1,22 @@ +历史会话 +========= + +这里介绍历史会话功能。 + +点击页面左侧“会话管理”菜单下的“历史会话”，进入历史会话列表页面。 + +.. contents:: Topics + +.. _view_history_session: + +查看历史会话 +````````````` + +历史会话页面默认展示一周内历史会话，页面左上角提供起止时间、用户、资产、系统用户等搜索过滤条件。 + +.. _playback_history_session: + +历史会话回放 +````````````` + +在在线会话列表中找到要回放的历史会话，点击动作标签下的“回放”按钮，弹出回放页面，完成回放历史会话。 \ No newline at end of file diff --git a/docs/session_online.rst b/docs/session_online.rst new file mode 100644 index 000000000..741725c1f --- /dev/null +++ b/docs/session_online.rst @@ -0,0 +1,25 @@ +在线会话 +========= + +这里介绍在线会话功能。 + +点击页面左侧“会话管理”菜单下的“在线会话”，进入在线会话列表页面。 + +.. contents:: Topics + +.. _view_online_session: + +查看在线会话 +````````````` + +在线会话页面默认展示一周内在线会话，页面左上角提供起止时间、用户、资产、系统用户等搜索过滤条件。 + +.. _stop_online_session: + +终断在线会话 +````````````` + +在在线会话列表中找到要终止的在线会话，点击动作标签下的“终断”按钮，完成终断在线会话。 + + + diff --git a/docs/session_terminal.rst b/docs/session_terminal.rst new file mode 100644 index 000000000..3f749af5c --- /dev/null +++ b/docs/session_terminal.rst @@ -0,0 +1,29 @@ +终端管理 +========= + +这里介绍终端管理功能。 + +点击页面左侧“会话管理”菜单下的“终端管理”，进入终端列表页面。 + +.. contents:: Topics + +.. _view_terminal_session: + +查看终端列表 +````````````` + +终端列表页面默认展示全部终端列表。 + +.. _upate_terminal_session: + +更新终端 +````````````` + +在在线会话列表中找到要更新的终端，点击动作标签下的“更新”按钮，在更新终端页面填写相关信息，点击提交，完成更新终端。 + +.. _delete_terminal_session: + +删除终端 +````````````` + +在在线会话列表中找到要删除的终端，点击动作标签下的“删除”按钮，在弹出确认删除页面点击确认，完成删除终端。 diff --git a/docs/session_web_terminal.rst b/docs/session_web_terminal.rst new file mode 100644 index 000000000..c388e44c4 --- /dev/null +++ b/docs/session_web_terminal.rst @@ -0,0 +1,23 @@ +Web终端 +========= + +这里介绍Web终端功能。 + +点击页面左侧“会话管理”菜单下的“Web终端”，进入Web终端页面。 + +.. contents:: Topics + +.. _login: + +主机登录 +````````````` + +点解页面左侧的”Web终端”，进入主机登录页，然后点击页面右侧的主机IP地址，连接主机，页面右侧会展示当前连接的终端信息。 + +.. _logout: + +主机登出 +````````````` + +在主机登录页面，选择左上角的“服务器”按钮，出现两个选项，一个“断开链接“按钮，断开当前连接的主机；另一个”断开所有链接“，断开当前所有连接的主机。 +