Adjust overview top margin

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

diff --git a/README.md b/README.md
index 52a6cdb439ee7083903ec7d2d119caba3f851dc7..3ac6d0fd7e017a7851328960c96d7248936720b8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,70 @@
 # unrealircd-webpanel
  UnrealIRCd Administration WebPanel
  
- <img src="https://i.ibb.co/7jtddG4/Screenshot-from-2022-12-31-04-53-35.png">
-(wuuuut)
+ <img src="https://i.ibb.co/yP7tk6B/Screenshot-from-2023-01-10-17-54-01.png">
+
+## Prerequisites ##
+- PHP 8 or later
+- A webserver
+- UnrealIRCd 6.0.6-git recommended. Minimal functionality available with UnrealIRCd 6.0.5.
+
+Note: PHP 8 may require special installation instructions.
+Here are some instructions for:
+- [Ubuntu 20/22](https://linuxhint.com/install-php-8-ubuntu-22-04/)
+- [Debian](https://www.vultr.com/docs/how-to-install-php-8-on-debian-11/)
+- [CentOS](https://www.tecmint.com/install-php-8-on-centos/)
+
+For more installation methods for PHP 8, make a websearch for how to install PHP 8 on your operating system.
+## 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/unrealircd/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:<br>
+<img src="https://i.ibb.co/zZ7LsXD/Screenshot-from-2023-01-04-17-03-20.png">
+
+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.