Make the Services overview card live too

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

diff --git a/config.php.sample b/config.php.sample
index 54432b1402b465961aa739ad152e3ef462f7118c..29aa5930ec9e463ba6aef8979032d2c230ee0159 100644 (file)
--- a/config.php.sample
+++ b/config.php.sample
@@ -5,13 +5,20 @@
  * 
  */
 
-
  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
+ *  Guide / Documentation: https://www.unrealircd.org/docs/JSON-RPC
 */
 define( 'UNREALIRCD_RPC_USER', 'apiuser' );
 
@@ -28,28 +35,100 @@ 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 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 );
 
-
 /**
  * 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",
-    ]
-);
\ No newline at end of file
+       '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 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', "unrealircdwebpanel");
+/**
+ * SQL Username
+ */
+define('SQL_USERNAME', "unrealircdwebpanel");
+
+/**
+ * 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"
+]);
+
+/** 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",
+
+]);