X-Git-Url: https://jfr.im/git/irc/unrealircd/unrealircd-webpanel.git/blobdiff_plain/f3bd8d74516e455fdb85e4176b6913166291f035..33f512fa30c06fa488c42e68f9bc9f401300a5ab:/README.md
diff --git a/README.md b/README.md
index 3d06cce..0592577 100644
--- 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
+## Example Overview from Mobile
+
+
## Prerequisites ##
- PHP 8 or later
- A webserver
@@ -34,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.
@@ -69,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)
+
+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
+
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