README.md

   1  ## UnrealIRCd Administration WebPanel
   2
   3 [![Version](https://img.shields.io/badge/UnrealIRCd-6.0.6_or_later-darkgreen.svg)]()
   4 [![Version](https://img.shields.io/badge/Version-Beta-blue.svg)]()
   5 [![Maintained](https://img.shields.io/badge/Maintained-yes-darkgreen.svg)]()
   6 [![Unreal](https://img.shields.io/badge/PHP-8.0_or_later-darkgreen.svg)](https://unrealircd.org)
   7
   8  Are you tired of managing your IRC network through a command line interface? Do you wish there was a more user-friendly way to keep track of your servers, channels, and users? Look no further than the UnrealIRCd Web Panel!
   9
  10 This web-based tool provides a comprehensive overview of your IRC network, including all channels and users, as well as detailed information about individual servers and users. With the UnrealIRCd Web Panel, you can easily add and remove server bans and spamfilter entries, rehash your entire network, and filter lists of information based on input criteria, all from the convenience of your web browser.
  11
  12 One of the key features of the UnrealIRCd Web Panel is its user-friendly interface. The panel is designed to be easy to navigate, with all the information you need displayed in an organized and easy-to-understand format. This makes it much easier to manage your network, especially if you have multiple servers or a large number of users.
  13
  14 Additionally, the UnrealIRCd Web Panel is a great tool for keeping track of your network's activity. You can view detailed information about the channels and users on your network as well as manage your servers. This allows you to quickly identify and address any issues that may arise.
  15
  16 Overall, the UnrealIRCd Web Panel is a must-have tool for any administrator managing an IRC network. Its user-friendly interface and powerful management capabilities make it easy to keep track of your network and ensure that everything is running smoothly. So why not give it a try and see how it can improve your IRC network management experience?
  17
  18 ## Example Overview from Desktop
  19  <img src="https://i.ibb.co/7SdFZnk/Screenshot-from-2023-01-14-07-26-21.png">
  20  <img src="https://i.ibb.co/6vQ6wg7/spamfilter.png">
  21
  22 ## Example Overview from Mobile
  23 <div class="row">
  24 <img src="https://i.ibb.co/KGLdB43/Screenshot-20230123-233804-Chrome.jpg" height="30%" width="30%">
  25 <img src="https://i.ibb.co/tB980kd/Screenshot-20230124-000204-Chrome.jpg" height="30%" width="30%">
  26 </div>
  27
  28 ## Prerequisites ##
  29 - UnrealIRCd 6.0.6 or later
  30 - A webserver (e.g. apache or nginx)
  31 - PHP 8 or later
  32
  33 Note: PHP 8 may require special installation instructions.
  34 Here are some instructions for:
  35 - Ubuntu 22.04: `apt-get install apache2 libapache2-mod-php`
  36 - [Ubuntu 20.04](https://linuxhint.com/install-php-ubuntu/)
  37 - [Debian](https://www.vultr.com/docs/how-to-install-php-8-on-debian-11/)
  38 - [CentOS](https://www.tecmint.com/install-php-8-on-centos/)
  39
  40 For more installation methods for PHP 8, make a websearch for how to install PHP 8 on your operating system.
  41 ## Installation ##
  42
  43 Note: This instructional assumes this is going to be hosted in the webroot directory `/var/www/` (html/) directory.
  44
  45 Please make sure you have [correctly setup UnrealIRCd for use with JSON-RPC](https://www.unrealircd.org/docs/JSON-RPC) before you continue.
  46
  47 - Go to your webserver root, for example `/var/www/html/`, and clone
  48   this repository:
  49 ```
  50 cd /var/www/html
  51 git clone https://github.com/unrealircd/unrealircd-webpanel
  52 ```
  53
  54 - Go into the directory and run composer to install the dependencies
  55   (If you don't have composer, then [install it](https://getcomposer.org/download/) first):
  56 ```
  57 cd unrealircd-webpanel
  58 composer install
  59 ```
  60
  61 - Edit the configuration file
  62 ```
  63 cp config.php.sample config.php
  64 nano config.php
  65 ```
  66 Edit the configuration file to match your UnrealIRCd's RPC credentials and save
  67
  68 IMPORTANT: You will want to put the webpanel behind a login, using a
  69 `.htaccess` file or similar. Don't open it up to the world!
  70
  71 ## Updating for end-users ##
  72 For end-users, when you want to update to the latest version:
  73 ```bash
  74 git pull
  75 composer install
  76 ```
  77
  78 ## Authentication
  79 Right now, by default everyone being able to access the URL can use the
  80 webpanel. In future versions this will no longer be the case.
  81
  82 ### SQL Authentication
  83 First, create a database and a user in MySQL or MariaDB. Typical commands to
  84 do so are:
  85
  86 ```sql
  87 CREATE DATABASE unrealircdwebpanel;
  88 CREATE USER 'unrealircdwebpanel'@'localhost' IDENTIFIED BY 'enter-some-random-password-here';
  89 GRANT ALL ON unrealircdwebpanel.* TO 'unrealircdwebpanel'@'localhost';
  90 ```
  91
  92 Now, open your `config.php` and in the define PLUGINS section load the `sql_auth`
  93 module by uncommenting the // from the `"sql_auth"` line.
  94 And fill in the information for your SQL setup, so set `SQL_IP`,
  95 `SQL_DATABASE`, `SQL_USERNAME` and `SQL_PASSWORD` properly.
  96
  97 Finally, configure a first admin user by setting the information in
  98 `SQL_DEFAULT_USER`. This will be added to the SQL database first time you
  99 start the panel.
 100
 101 Then, surf to the webpanel page and you should see a login page. If you
 102 don't see a login page then you have not loaded the sql_auth plugin
 103 properly.
 104
 105 Once succesfully logged in you should remove the `SQL_DEFAULT_USER` item
 106 again from your `config.php` because it is no longer needed.
 107
 108 You can now add and delete users through the `Panel Access` tab.
 109
 110 ## Developers ##
 111 Developers of the webpanel will naturally use the same procedure as
 112 above. However, sometimes you will want to update to a newer version
 113 of the unrealircd-rpc-php library. You then need to run:
 114 ```bash
 115 # For devs only!
 116 composer update
 117 git commit composer.lock
 118 ```
 119 Commiting the composer.lock file updates the dependency for all
 120 other users, that way a `composer update` by end-users will update
 121 to exactly the version that `composer install` just installed.