README.md

   1 # unrealircd-webpanel
   2  UnrealIRCd Administration WebPanel
   3
   4  <img src="https://i.ibb.co/yP7tk6B/Screenshot-from-2023-01-10-17-54-01.png">
   5
   6 ## Prerequisites ##
   7 - PHP 8 or later
   8 - A webserver
   9 - UnrealIRCd 6.0.6-git recommended. Minimal functionality available with UnrealIRCd 6.0.5.
  10
  11 Note: PHP 8 may require special installation instructions.
  12 Here are some instructions for:
  13 - [Ubuntu 20/22](https://linuxhint.com/install-php-8-ubuntu-22-04/)
  14 - [Debian](https://www.vultr.com/docs/how-to-install-php-8-on-debian-11/)
  15 - [CentOS](https://www.tecmint.com/install-php-8-on-centos/)
  16
  17 For more installation methods for PHP 8, make a websearch for how to install PHP 8 on your operating system.
  18 ## Installation ##
  19
  20 Note: This instructional assumes this is going to be hosted in the webroot directory `/var/www/` (html/) directory.
  21 You may want to hide this somehow. Well, you definitely should. I don't know how to do that though. Sorry.
  22
  23 Please make sure you have [correctly setup UnrealIRCd for use with JSON-RPC](https://www.unrealircd.org/docs/JSON-RPC) before you continue.
  24
  25 - Go to your webserver root, for example `/var/www/html/`, and clone
  26   this repository:
  27 ```
  28 cd /var/www/html
  29 git clone https://github.com/unrealircd/unrealircd-webpanel
  30 ```
  31
  32 - Go into the directory and run composer to install the dependencies
  33   (If you don't have composer, then [install it](https://getcomposer.org/download/) first):
  34 ```
  35 cd unrealircd-webpanel
  36 composer install
  37 ```
  38
  39 - Edit the configuration file
  40 ```
  41 cp config.php.sample config.php
  42 nano config.php
  43 ```
  44 The file will look like this:<br>
  45 <img src="https://i.ibb.co/zZ7LsXD/Screenshot-from-2023-01-04-17-03-20.png">
  46
  47 Edit the configuration file to match your UnrealIRCd's RPC credentials and save
  48
  49 NOTE: You most likely want to put the webpanel behind a login, using a
  50 `.htaccess` file or similar.
  51
  52 ## Updating for end-users ##
  53 For end-users, when you want to update to the latest version:
  54 ```bash
  55 git pull
  56 composer update
  57 ```
  58
  59 ## Developers ##
  60 Developers of the webpanel will naturally use the same procedure as
  61 above. However, sometimes you will want to update to a newer version
  62 of the unrealircd-rpc-php library. You then need to run:
  63 ```bash
  64 # For devs only!
  65 composer install
  66 git commit composer.lock
  67 ```
  68 Commiting the composer.lock file updates the dependency for all
  69 other users, that way a `composer update` by end-users will update
  70 to exactly the version that `composer install` just installed.