]> jfr.im git - irc/unrealircd/unrealircd-webpanel.git/blobdiff - config.php.sample
javascript function to generate a new toast notification
[irc/unrealircd/unrealircd-webpanel.git] / config.php.sample
index a019293e71ed7c535bce250392594b92bebe90a5..14f0fba778c361be3dd96f15047410f7990e774c 100644 (file)
@@ -6,7 +6,7 @@
  */
 
  if (!defined('UPATH'))
-    die("Access denied");
+       die("Access denied");
 
 /**
  * The base URL, how this panel can be accessed.
@@ -18,9 +18,9 @@ define( 'BASE_URL', '/unrealircd-webpanel/' );
 
 /**
  *  The RPC User name as defined in your unrealircd.conf
- *  Guide / Documentation: https://www.unrealircd.org/docs/JSON-RPC
+ *  https://www.unrealircd.org/docs/UnrealIRCd_webpanel#Configuring_UnrealIRCd
 */
-define( 'UNREALIRCD_RPC_USER', 'apiuser' );
+define( 'UNREALIRCD_RPC_USER', 'adminpanel' );
 
 /**
  *  The RPC User password as defined in your unrealircd.conf
@@ -35,7 +35,7 @@ define( 'UNREALIRCD_HOST', '127.0.0.1' );
 /**
  * The port of your RPC server as defined in your unrealircd.conf
 */
-define( 'UNREALIRCD_PORT', '8000' );
+define( 'UNREALIRCD_PORT', '8600' );
 
 /** 
  * You should set this to true, if your RPC server is not on your local host
@@ -47,25 +47,45 @@ define( 'UNREALIRCD_SSL_VERIFY', false );
 */
 define( 'UNREALIRCD_DEBUG', false );
 
+/**
+ * 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", /* An example plugin */
+               //"sql_auth", /* Provides a login page which uses SQL */
+               //"php_mailer", /* Provides ability to send emails on behalf of the admin panel */
+       ]
+);
+
 
 /**
- * If you wish to use the default SQL user authentication system,
+ * 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");
+define('SQL_DATABASE', "unrealircdwebpanel");
 /**
  * SQL Username
  */
-define('SQL_USERNAME', "unrealircd");
+define('SQL_USERNAME', "unrealircdwebpanel");
 
 /**
  * SQL Password
@@ -86,19 +106,29 @@ define('SQL_PREFIX', "unreal_");
  * that you remove it after you've logged in successfully.
  */
 define('SQL_DEFAULT_USER', [
-    "username" => "default",
-    "password" => "testing"
+       "username" => "default",
+       "password" => "testing"
 ]);
 
 /**
- * Your list of plugins:
- */
-define(
-    'PLUGINS', [
+ * 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"
+]);
 
-        /*  This is where you should type the name(s) of your plugins. 
-         *  Uncomment the following line to view the live example
-        */
-        //"example_plugin",
-    ]
-);
+/** Your email settings
+ * Requires plugin "php_mailer"
+*/
+define('EMAIL_SETTINGS', [
+    "host" => 'smtp.host.example.com',
+    "port" => 587,
+    "encryption" => 'tls', /* Use 'tls' for STARTTLS or 'ssl' for TLS/SSL */
+    "username" => "youremail@example.com", /* The email to login with and send emails from */
+    "password" => "supersecretpassword", /* The password for the above email */
+    "from_name" => "UnrealIRCd Admin Panel",
+
+]);