X-Git-Url: https://jfr.im/git/irc/unrealircd/unrealircd-webpanel.git/blobdiff_plain/14d6638510092920bd7772fb00df829080e550aa..9307cc64b4a005d16ce021274274f664d8f6b10d:/README.md?ds=inline
diff --git a/README.md b/README.md
index e064ee3..2ed3227 100644
--- a/README.md
+++ b/README.md
@@ -15,13 +15,20 @@ 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 ##
+- UnrealIRCd 6.0.6 or later
+- A webserver (e.g. apache or nginx)
- 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:
@@ -34,7 +41,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.
@@ -57,13 +63,10 @@ composer install
cp config.php.sample config.php
nano config.php
```
-The file will look like this:
-
-
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.
+IMPORTANT: You will want to put the webpanel behind a login, using a
+`.htaccess` file or similar. Don't open it up to the world!
## Updating for end-users ##
For end-users, when you want to update to the latest version:
@@ -72,6 +75,31 @@ git pull
composer install
```
+## Authentication
+Right now, by default everyone being able to access the URL can use the
+webpanel. In future versions this will no longer be the case.
+There are currently two authentication methods under 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