feat: 更新模块文档,添加详细说明和使用示例
This commit is contained in:
@@ -1,6 +1,36 @@
|
||||
"""Web TUI 模块
|
||||
"""Web TUI 模块 - Web 管理界面
|
||||
|
||||
提供 Web 终端界面、SSH 连接管理
|
||||
本模块提供基于 Web 的终端管理界面:
|
||||
|
||||
认证管理 (auth):
|
||||
- AuthManager: 认证管理器
|
||||
- AuthToken: 认证令牌
|
||||
- 支持 JWT 令牌认证
|
||||
- 令牌刷新和撤销
|
||||
|
||||
SSH 管理 (ssh_manager):
|
||||
- SSHManager: SSH 连接管理器
|
||||
- SSHSession: SSH 会话封装
|
||||
- 支持多会话管理
|
||||
- WebSocket 实时终端
|
||||
|
||||
Web 服务 (server):
|
||||
- FastAPI 应用
|
||||
- 静态文件服务
|
||||
- WebSocket 终端
|
||||
- RESTful API
|
||||
|
||||
使用示例:
|
||||
>>> from minenasai.webtui import get_auth_manager
|
||||
>>>
|
||||
>>> # 获取认证管理器
|
||||
>>> auth = get_auth_manager()
|
||||
>>>
|
||||
>>> # 生成令牌
|
||||
>>> token = auth.generate_token(user_id="admin")
|
||||
>>>
|
||||
>>> # 验证令牌
|
||||
>>> user_info = auth.verify_token(token.token)
|
||||
"""
|
||||
|
||||
from minenasai.webtui.auth import AuthManager, AuthToken, get_auth_manager
|
||||
|
||||
Reference in New Issue
Block a user