maso/laravel-terminal

A Laravel package that enables developers to run shell commands directly through the browser.

v1.0.0 2024-10-23 13:11 UTC

Requires

• php: ^7.4|^8.0
• laravel/framework: ^11

MIT

• Majd Soubh

• maso
• laravel-terminal

README

Laravel Terminal is a package that allows you to interact with a shell environment directly from your browser. This tool is designed for development purposes only and should not be used in production environments due to security risks associated with exposing shell access.

Installation

You can install the package via composer:

composer require maso/laravel-terminal

Publish the package's configuration files:

php artisan vendor:publish --provider="Maso\LaravelTerminal\LaravelTerminalServiceProvider" --tag="config"

Usage

Once installed and configured, navigate to /terminal in your browser to access the terminal interface.

Warning : Executing interactive commands (e.g., commands that expect user input or running services) through the web interface will cause the server to hang. To resolve this, you will need to manually restart the server.

Security Considerations

This package is intended for development purposes only. Since it exposes shell access to your application, it is highly recommended to secure the route using middleware such as authentication or IP whitelisting to prevent unauthorized access. This can be done by modifying route array in the config/laravel-terminal.php file :

'route' => [
    'prefix' => 'terminal',
    'as' => 'terminal.',
    'middleware' => ['auth', 'can:access-terminal'], // Example: Add your middleware here
],

Contributing

Contributions are welcome! If you'd like to improve this package, feel free to fork it, submit issues, or make pull requests.

Security

If you discover any security vulnerabilities, please contact me directly at [e-mail]. If the issue is not resolved quickly, you may open an issue on GitHub.

Credits

• Majd Soubh