Add SQL config items to config sample

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

diff --git a/config.php.sample b/config.php.sample
index c40af52c2ac1a25ce6ab93f4eadfe472b4b446be..94a47e9e4704c1b946f62ffdfe5ce45937412197 100644 (file)
--- a/config.php.sample
+++ b/config.php.sample
@@ -5,13 +5,20 @@
  * 
  */
 
-
  if (!defined('UPATH'))
     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
+ *  Guide / Documentation: https://www.unrealircd.org/docs/JSON-RPC
 */
 define( 'UNREALIRCD_RPC_USER', 'apiuser' );
 
@@ -31,11 +38,57 @@ define( 'UNREALIRCD_HOST', '127.0.0.1' );
 define( 'UNREALIRCD_PORT', '8000' );
 
 /** 
- * You should set this to true if your RPC server is not on our local host
+ * You should set this to true, if your RPC server is not on your local host
 */
 define( 'UNREALIRCD_SSL_VERIFY', false );
 
 /**
- * You should only need this if you're developing something.
+ * You should only need this, if you're developing something.
 */
-define( 'UNREALIRCD_DEBUG', false );
\ No newline at end of file
+define( 'UNREALIRCD_DEBUG', false );
+
+
+/**
+ * If you wish to use the default SQL user authentication system,
+ * you'll need to specify your SQL information below.
+ */
+
+ /**
+  * SQL IP address or hostname
+  */
+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_");
+
+
+/**
+ * Your list of plugins:
+ */
+define(
+    'PLUGINS', [
+
+        /*  This is where you should type the name(s) of your plugins. 
+         *  Uncomment the following line to view the live example
+        */
+        //"example_plugin",
+    ]
+);