samdark / yii2-webshell
A web shell that allows to run yii console commands and create your own commands.
Installs: 66 491
Dependents: 0
Suggesters: 0
Security: 0
Stars: 227
Watchers: 33
Forks: 36
Open Issues: 5
Type:yii2-extension
Requires
- bower-asset/jquery.terminal: ~0.8.8
- yiisoft/yii2: ~2.0.0
This package is auto-updated.
Last update: 2024-10-24 03:34:41 UTC
README
Web shell allows to run yii
console commands using a browser.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist samdark/yii2-webshell "~2.0"
or add
"samdark/yii2-webshell": "~2.0"
to the require section of your composer.json
file.
Configuration
To use web shell, include it as a module in the application configuration like the following:
return [ 'modules' => [ 'webshell' => [ 'class' => 'samdark\webshell\Module', // 'yiiScript' => Yii::getAlias('@root'). '/yii', // adjust path to point to your ./yii script ], ], // ... other application configuration ]
With the above configuration, you will be able to access web shell in your browser using
the URL http://localhost/path/to/index.php?r=webshell
Access control
By default access is restricted to local IPs. It could be changed via allowedIPs
property. Additionally,
checkAccessCallback
is available to be able to introduce custom access control:
return [ 'modules' => [ 'webshell' => [ 'class' => 'samdark\webshell\Module', // 'yiiScript' => Yii::getAlias('@root'). '/yii', // adjust path to point to your ./yii script 'allowedIPs' => ['127.0.0.1', '::1', '192.168.0.2'], 'checkAccessCallback' => function (\yii\base\Action $action) { // return true if access is granted or false otherwise return true; } ], ], // ... other application configuration ]
Limitations
Web shell is unable to work interactively because of request-response nature of web. Therefore you should disable interactive mode for commands.