|
1 | | -# Novnc handling plugin for MyAdmin |
| 1 | +# MyAdmin NoVNC Plugin |
2 | 2 |
|
3 | | -Novnc handling plugin for MyAdmin |
| 3 | +[](https://github.com/detain/myadmin-novnc-plugin/actions) |
| 4 | +[](https://packagist.org/packages/detain/myadmin-novnc-plugin) |
| 5 | +[](https://packagist.org/packages/detain/myadmin-novnc-plugin) |
| 6 | +[](https://packagist.org/packages/detain/myadmin-novnc-plugin) |
4 | 7 |
|
5 | | -## Build Status and Code Analysis |
| 8 | +A plugin for the [MyAdmin](https://github.com/detain/myadmin) control panel framework that provides NoVNC HTML5 VNC connection handling. This plugin integrates browser-based VNC access into MyAdmin, enabling remote desktop connectivity through an HTML5-compatible interface without requiring standalone VNC client software. |
6 | 9 |
|
7 | | -Site | Status |
8 | | ---------------|--------------------------- |
9 | | - | [](https://travis-ci.org/detain/myadmin-novnc-plugin) |
10 | | - | [](https://codeclimate.com/github/detain/myadmin-novnc-plugin) [](https://codeclimate.com/github/detain/myadmin-novnc-plugin/coverage) [](https://codeclimate.com/github/detain/myadmin-novnc-plugin) |
11 | | - | [](https://scrutinizer-ci.com/g/myadmin-plugins/novnc-plugin/?branch=master) [](https://scrutinizer-ci.com/g/myadmin-plugins/novnc-plugin/?branch=master) [](https://scrutinizer-ci.com/g/myadmin-plugins/novnc-plugin/build-status/master) |
12 | | - | [](https://www.codacy.com/app/detain/myadmin-novnc-plugin) [](https://www.codacy.com/app/detain/myadmin-novnc-plugin?utm_source=github.com&utm_medium=referral&utm_content=detain/myadmin-novnc-plugin&utm_campaign=Badge_Coverage) |
13 | | - | [](https://coveralls.io/github/detain/myadmin-novnc-plugin?branch=master) |
14 | | - | [](https://packagist.org/packages/detain/myadmin-novnc-plugin) [](https://packagist.org/packages/detain/myadmin-novnc-plugin) [](//packagist.org/packages/detain/myadmin-novnc-plugin) [](https://packagist.org/packages/detain/myadmin-novnc-plugin) [](https://packagist.org/packages/detain/myadmin-novnc-plugin) [](https://packagist.org/packages/detain/myadmin-novnc-plugin) |
| 10 | +## Features |
15 | 11 |
|
| 12 | +- HTML5-based VNC connections via NoVNC |
| 13 | +- Seamless integration with the MyAdmin plugin system |
| 14 | +- Event-driven architecture using Symfony EventDispatcher |
| 15 | +- Admin menu and settings integration |
| 16 | + |
| 17 | +## Requirements |
| 18 | + |
| 19 | +- PHP 8.2 or higher |
| 20 | +- ext-soap |
| 21 | +- Symfony EventDispatcher 5.x, 6.x, or 7.x |
16 | 22 |
|
17 | 23 | ## Installation |
18 | 24 |
|
19 | | -Install with composer like |
| 25 | +Install via Composer: |
20 | 26 |
|
21 | 27 | ```sh |
22 | 28 | composer require detain/myadmin-novnc-plugin |
23 | 29 | ``` |
24 | 30 |
|
25 | | -## License |
| 31 | +## Usage |
| 32 | + |
| 33 | +The plugin registers itself automatically through the MyAdmin plugin loader system. It hooks into the event dispatcher to provide menu entries and configuration settings for NoVNC connections. |
| 34 | + |
| 35 | +## Testing |
26 | 36 |
|
27 | | -The Novnc handling plugin for MyAdmin class is licensed under the LGPL-v2.1 license. |
| 37 | +Run the test suite with PHPUnit: |
| 38 | + |
| 39 | +```sh |
| 40 | +composer install |
| 41 | +vendor/bin/phpunit |
| 42 | +``` |
| 43 | + |
| 44 | +## License |
28 | 45 |
|
| 46 | +This package is licensed under the [LGPL-2.1](LICENSE) license. |
0 commit comments