Rather large update, please see commit notes

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

diff --git a/README.md b/README.md
index a2fa93a54bec843d4cb17f301e245707e789e927..05925773abb09a4e7d11673ed4a6b450df9f5bb0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,9 +15,12 @@ Additionally, the UnrealIRCd Web Panel is a great tool for keeping track of your
 
 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?
 
-## Example Overview
+## Example Overview from Desktop
  <img src="https://i.ibb.co/7SdFZnk/Screenshot-from-2023-01-14-07-26-21.png">
 
+## Example Overview from Mobile
+<img src="https://i.ibb.co/KGLdB43/Screenshot-20230123-233804-Chrome.jpg">
+
 ## Prerequisites ##
 - PHP 8 or later
 - A webserver
@@ -25,7 +28,8 @@ Overall, the UnrealIRCd Web Panel is a must-have tool for any administrator mana
 
 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/)
+- Ubuntu 22.04: `apt-get install apache2 libapache2-mod-php`
+- [Ubuntu 20.04](https://linuxhint.com/install-php-ubuntu/)
 - [Debian](https://www.vultr.com/docs/how-to-install-php-8-on-debian-11/)
 - [CentOS](https://www.tecmint.com/install-php-8-on-centos/)
 
@@ -33,7 +37,6 @@ For more installation methods for PHP 8, make a websearch for how to install PHP
 ## 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.
 
@@ -56,9 +59,6 @@ composer install
 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
@@ -71,6 +71,30 @@ git pull
 composer install
 ```
 
+## Authentication
+There will be at least two methods of authentication. Currently in
+development:
+
+- SQL (available but still in development!)
+- Local File DB (not public yet)
+
+### SQL Authentication (Work In Progress)
+<img width="130" height="100" src="https://cdn.shopify.com/s/files/1/1140/2002/products/UV-10073Cautionuseatyourownrisk-01_1024x1024.png?v=1588174823">
+In order to use the SQL Authentication plugin you must first make
+sure you have an SQL database which UnrealIRCd Admin Panel can
+access.
+
+Make sure you've put your SQL details in `config.php` and that you
+have `"sql_auth",` in the plugins section of the config.
+
+You can create the first user by following the example in `config.php`. 
+After you've logged in, you will have two new tabs: `Panel Access` and `Logout`. 
+You will be able to add and delete users from the `Panel Access` tab.
+
+### Local File DB
+<img width="27" height="27" src="https://media2.giphy.com/media/3o7TKtnuHOHHUjR38Y/giphy.gif?cid=6c09b95281771195a917f87730a56bcdcfa5b6f418dcaf5e&rid=giphy.gif&ct=s"> This might take a while. Please wait a few days.
+
+
 ## Developers ##
 Developers of the webpanel will naturally use the same procedure as
 above. However, sometimes you will want to update to a newer version