From: Valerie Pond Date: Thu, 19 Jan 2023 15:45:33 +0000 (+0000) Subject: Update README about authentication plugin X-Git-Tag: 0.9~397 X-Git-Url: https://jfr.im/git/irc/unrealircd/unrealircd-webpanel.git/commitdiff_plain/8d6871b97c2b1a80574c4deac9294bf94c406802?hp=a5400f9ae847a0ab45de050a721c57ba212399ed Update README about authentication plugin --- diff --git a/README.md b/README.md index 3d06cce..58c86f7 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,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 +68,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