Allow adding spamfilter entries

[irc/unrealircd/unrealircd-webpanel.git] / README.md

diff --git a/README.md b/README.md
index 3022c85428a793d6012145d142d9a807eeb393b0..c18f52613a4a709df7f6a0730bb3ded0e8298a2c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
  <img src="https://i.ibb.co/7jtddG4/Screenshot-from-2022-12-31-04-53-35.png">
 
 ## Prerequisites ##
-- PHP 7 or later
+- PHP 8 or later
 - A webserver
 - UnrealIRCd 6.0.5
 
@@ -15,20 +15,23 @@ You may want to hide this somehow. Well, you definitely should. I don't know how
 
 Please make sure you have [correctly setup UnrealIRCd for use with JSON-RPC](https://www.unrealircd.org/docs/JSON-RPC) before you continue.
 
-1. First, if you have just installed apache2 or something else, remove the `html` directory and navigate to `/var/www/`
+- Go to your webserver root, for example `/var/www/html/`, and clone
+  this repository:
 ```
-cd /var/www/
-rm -rf html
+cd /var/www/html
+git clone https://github.com/ValwareIRC/unrealircd-webpanel
 ```
 
-2. Clone this repository to a new directory called `html`
+- 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):
 ```
-git clone https://github.com/ValwareIRC/unrealircd-webpanel html
+cd unrealircd-webpanel
+composer install
 ```
 
-3. Move into the `html` directory and edit the configuration file
+- Edit the configuration file
 ```
-cd html
+cp config.php.sample config.php
 nano config.php
 ```
 The file will look like this:<br>
@@ -36,3 +39,25 @@ The file will look like this:<br>
 
 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.
+
+## Updating for end-users ##
+For end-users, when you want to update to the latest version:
+```bash
+git pull
+composer update
+```
+
+## Developers ##
+Developers of the webpanel will naturally use the same procedure as
+above. However, sometimes you will want to update to a newer version
+of the unrealircd-rpc-php library. You then need to run:
+```bash
+# For devs only!
+composer install
+git commit composer.lock
+```
+Commiting the composer.lock file updates the dependency for all
+other users, that way a `composer update` by end-users will update
+to exactly the version that `composer install` just installed.