README.md

WSHELL

一个可以在网页上访问shell的小工具，它基于以下技术或工具开发：

• uliweb
• gevent
• greenlet
• gevent-socketio(依赖gevent-websocket)
• socketio.js
• avalon.js 页面模板及动态更新
• jquery.terminal.js 前端终端功能组件
• semantic-ui 基础页面框架
• jqfileupload 实现文件上传

主要功能特性

• 用户登录方可使用
• 支持开多个终端窗口
• 支持shell交互，如mysql的命令行支持
• download filename 可以下载某个文件，会自动进行权限检查，用户为运行WShell的用户
• upload 可以上传文件
• show 可以查看图片

安装要求

• uliweb
• gevent
• greenlist
• green-websocket
• gevent-socketio

在项目目录下提供了 requirements.txt 文件，因此可以方便执行

pip install -r requirements.txt

来安装所需要的文件。

如何运行

运行时要先进入wshell安装目录下的wshell子目录，看到有apps子目录就对了。

测试

uliweb runserver --gevent-socketio

部署

使用 gevent_socketio_handler.py

配置说明

在 apps/server/settings.ini 提供了几个配置项，你可以在settings.ini中进行覆盖：

[WSHELL]
user = 'test'
password = 'test'
stop_interval = 30*60
login_path = '$PROJECT'
shell = False

分别解释如下：

• user, password 用来标识用户名和口令。在打开一个对话时，会先要进行登录。

• stop_interval 在后台服务运行时，因为有些子进程可能是以交互的形式在工作，所以 进程不会退出。但是如果长时间不用，会造成资源的消耗，所以后台程序会定时扫描 没有数据交互的进程，如果达到超时时间，则会主动杀掉。缺省时间为30分钟。

• login_path 表示登录后返回给前端的路径。缺省为 $PROJECT 表示项目目录，即 后台服务项目所在的目录。你可以修改为其它的起始目录。除 $PROJECT 外，还可以 使用 $HOME 。

• shell 表示在Linux下是否启用整条命令作为shell来执行。这样使得

  > a.txt
  ls *.log
  rm *.*
  

  成为可能，所以具有一定的风险性。

使用说明

布局说明

整个界面目录分为Tab导航和终端输入窗口。

点击Tab导航上的 + 可以创建多个窗口。

支持命令

目前WShell支持的命令分为前端命令，特殊命令和后端命令，其中：

• 前端命令(由前端实现)
  • clear 清屏
  • exit 退出，重新进入登录状态
  • close 关闭当前shell窗口
• 特殊命令(由前后端共同实现，为WShell特有)
  • download filename 可以用来下载当前目录下的filename文件
  • upload 可以上传文件。输入upload之后，会显示上传按钮，然后可以点击上传。 如果浏览器支持HTML5文件API的话，还可以拖拽上传。
  • show 命令可以显示指定文件(可以带通配符)或当前目录下的所有图片文件。
  • reset 清理后台未还在运行的子进程
  • 支持拖放一个文件到终端窗口即可上传文件到当前目录，文件缺省不会覆盖
• 后端命令(在后端通过调用shell来执行，支持简单的交互)
  • 将后端命令直接传给shell来运行，对于windows平台使用 cmd，对于linux使用 /bin/bash

自定义命令开发

用户可以自行开发特殊命令。

使用局限

WShell对简单的命令行交互有一定的支持，比如mysql，但是它无法实现和真正终端一样的 输入编辑，特别是象python这样，可以输入块语句的命令行交互。所以不要用它进行这种 复杂的处理。

• mysql 建议使用 mysql -uuser -ppassword [database] ，目前口令要一起给出 还无法实现动态交互。

浏览器要求

建议使用支持HTML5浏览器，chrome, firefox

版权声明

本软件使用 MIT 协议发布