X-Git-Url: https://jfr.im/git/irc/unrealircd/unrealircd-webpanel.git/blobdiff_plain/f217c52a4fa8982560318210ef6d1779c9ea9fa8..579020f8c67f7bdfd9d530a25b701af6ee53c412:/README.md diff --git a/README.md b/README.md index be07bbe..eead3e7 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,24 @@ -# unrealircd-webpanel - UnrealIRCd Administration WebPanel + ## UnrealIRCd Administration WebPanel - - -## Prerequisites ## -- PHP 7 or later -- A webserver -- UnrealIRCd 6.0.5 +[![Version](https://img.shields.io/badge/UnrealIRCd-6.1.0_or_later-darkgreen.svg)]() +[![Version](https://img.shields.io/badge/Version-0.9-blue.svg)]() +[![Maintained](https://img.shields.io/badge/Maintained-yes-darkgreen.svg)]() +[![Unreal](https://img.shields.io/badge/PHP-8.0_or_later-darkgreen.svg)](https://unrealircd.org) + +The UnrealIRCd Administration WebPanel gives you an overview of your IRC network, +with detailed information about servers, users and channels. +You can easily add and remove server bans, spamfilters and do other administrative tasks, +all from the convenience of your web browser. + +## Example Overview from Desktop + + + +## Example Overview from Mobile +
+ + +
## Installation ## - -Note: This instructional assumes this is going to be hosted in the webroot directory `/var/www/` (html/) directory. -You may want to hide this somehow. Well, you definitely should. I don't know how to do that though. Sorry. - -Please make sure you have [correctly setup UnrealIRCd for use with JSON-RPC](https://www.unrealircd.org/docs/JSON-RPC) before you continue. - -- Go to your webserver root, for example `/var/www/html/`, and clone - this repository: -``` -cd /var/www/html -git clone https://github.com/ValwareIRC/unrealircd-webpanel -``` - -- Go into the directory and run composer to install the dependencies - (If you don't have composer, then [install it](https://getcomposer.org/download/) first): -``` -cd unrealircd-webpanel -composer install -``` - -- Edit the configuration file -``` -cp config.php.sample config.php -nano config.php -``` -The file will look like this:
- - -Edit the configuration file to match your UnrealIRCd's RPC credentials and save - -NOTE: You most likely want to put the webpanel behind a login, using a -`.htaccess` file or similar. +See https://www.unrealircd.org/docs/UnrealIRCd_webpanel for all documentation.