Make a start on filtering for later

[irc/unrealircd/unrealircd-webpanel.git] / config.php.sample

diff --git a/config.php.sample b/config.php.sample
index 96a53143caa9c9949d70d1ce32124cbd6d297c48..6726eb846ed634231fd05ca03336ca027851f8e9 100644 (file)
--- a/config.php.sample
+++ b/config.php.sample
@@ -5,10 +5,16 @@
  * 
  */
 
-
  if (!defined('UPATH'))
-    die("Access denied");
+       die("Access denied");
 
+/**
+ * The base URL, how this panel can be accessed.
+ * This would be '/' if you installed in the web root,
+ * or something like '/webpanel/' if you go to http://x.y.z/webpanel
+ * IMPORTANT: needs a trailing slash!
+*/
+define( 'BASE_URL', '/unrealircd-webpanel/' );
 
 /**
  *  The RPC User name as defined in your unrealircd.conf
@@ -41,16 +47,74 @@ define( 'UNREALIRCD_SSL_VERIFY', false );
 */
 define( 'UNREALIRCD_DEBUG', false );
 
-
 /**
  * Your list of plugins:
  */
 define(
-    'PLUGINS', [
+       'PLUGINS', [
 
-        /*  This is where you should type the name(s) of your plugins. 
-         *  Uncomment the following line to view the live example
-        */
-        //"example_plugin",
-    ]
+               /*  This is where you should type the name(s) of your plugins. 
+                *  Uncomment the following line to view the live example
+               */
+               //"example_plugin", /* An example plugin */
+               //"sql_auth", /* Provides a login page which uses SQL */
+       ]
 );
+
+
+/**
+ * If you wish to use the SQL user authentication system "sql_auth",
+ * you'll need to specify your SQL information below.
+ */
+
+ /**
+  * SQL IP address or hostname
+  * You may specify a unix domain socket directory address
+  * E.g:
+  *     define('SQL_IP', "/path/to/unix/domain/socket");
+  *
+  * Path to unix socket MUST start with a slash "/"
+  */
+define('SQL_IP', "127.0.0.1");
+
+/**
+ * SQL Dabase name
+ */
+define('SQL_DATABASE', "unrealircd");
+/**
+ * SQL Username
+ */
+define('SQL_USERNAME', "unrealircd");
+
+/**
+ * SQL Password
+ */
+define('SQL_PASSWORD', "replace_this_with_your_sql_password");
+
+/**
+ * SQL Table prefix
+ * You should only need to change this if you have already have one
+ * or more instances of webpanel on the same database
+ */
+define('SQL_PREFIX', "unreal_");
+
+
+/** 
+ * The default user for the plugin "SQL_Auth". As soon as you load
+ * the plugin, the user defined below will be created. It suggested
+ * that you remove it after you've logged in successfully.
+ */
+define('SQL_DEFAULT_USER', [
+       "username" => "default",
+       "password" => "testing"
+]);
+
+/**
+ * Also part of the SQL_Auth plugin. This protects your login page.
+ * This is a list of DNS Blacklists that get checked for non-logged-in
+ * users.
+*/
+define('DNSBL', [
+       "dnsbl.dronebl.org",
+       "rbl.efnetrbl.org"
+]);