]> jfr.im git - irc/unrealircd/unrealircd-webpanel.git/blob - config.php.sample
javascript function to generate a new toast notification
[irc/unrealircd/unrealircd-webpanel.git] / config.php.sample
1 <?php
2
3 /**
4 * The configuration file for your admin panel.
5 *
6 */
7
8 if (!defined('UPATH'))
9 die("Access denied");
10
11 /**
12 * The base URL, how this panel can be accessed.
13 * This would be '/' if you installed in the web root,
14 * or something like '/webpanel/' if you go to http://x.y.z/webpanel
15 * IMPORTANT: needs a trailing slash!
16 */
17 define( 'BASE_URL', '/unrealircd-webpanel/' );
18
19 /**
20 * The RPC User name as defined in your unrealircd.conf
21 * https://www.unrealircd.org/docs/UnrealIRCd_webpanel#Configuring_UnrealIRCd
22 */
23 define( 'UNREALIRCD_RPC_USER', 'adminpanel' );
24
25 /**
26 * The RPC User password as defined in your unrealircd.conf
27 */
28 define( 'UNREALIRCD_RPC_PASSWORD', 'securepassword' );
29
30 /**
31 * The host IP or name of your RPC server
32 */
33 define( 'UNREALIRCD_HOST', '127.0.0.1' );
34
35 /**
36 * The port of your RPC server as defined in your unrealircd.conf
37 */
38 define( 'UNREALIRCD_PORT', '8600' );
39
40 /**
41 * You should set this to true, if your RPC server is not on your local host
42 */
43 define( 'UNREALIRCD_SSL_VERIFY', false );
44
45 /**
46 * You should only need this, if you're developing something.
47 */
48 define( 'UNREALIRCD_DEBUG', false );
49
50 /**
51 * Your list of plugins:
52 */
53 define(
54 'PLUGINS', [
55
56 /* This is where you should type the name(s) of your plugins.
57 * Uncomment the following line to view the live example
58 */
59 //"example_plugin", /* An example plugin */
60 //"sql_auth", /* Provides a login page which uses SQL */
61 //"php_mailer", /* Provides ability to send emails on behalf of the admin panel */
62 ]
63 );
64
65
66 /**
67 * If you wish to use the SQL user authentication system "sql_auth",
68 * you'll need to specify your SQL information below.
69 */
70
71 /**
72 * SQL IP address or hostname
73 * You may specify a unix domain socket directory address
74 * E.g:
75 * define('SQL_IP', "/path/to/unix/domain/socket");
76 *
77 * Path to unix socket MUST start with a slash "/"
78 */
79 define('SQL_IP', "127.0.0.1");
80
81 /**
82 * SQL Dabase name
83 */
84 define('SQL_DATABASE', "unrealircdwebpanel");
85 /**
86 * SQL Username
87 */
88 define('SQL_USERNAME', "unrealircdwebpanel");
89
90 /**
91 * SQL Password
92 */
93 define('SQL_PASSWORD', "replace_this_with_your_sql_password");
94
95 /**
96 * SQL Table prefix
97 * You should only need to change this if you have already have one
98 * or more instances of webpanel on the same database
99 */
100 define('SQL_PREFIX', "unreal_");
101
102
103 /**
104 * The default user for the plugin "SQL_Auth". As soon as you load
105 * the plugin, the user defined below will be created. It suggested
106 * that you remove it after you've logged in successfully.
107 */
108 define('SQL_DEFAULT_USER', [
109 "username" => "default",
110 "password" => "testing"
111 ]);
112
113 /**
114 * Also part of the SQL_Auth plugin. This protects your login page.
115 * This is a list of DNS Blacklists that get checked for non-logged-in
116 * users.
117 */
118 define('DNSBL', [
119 "dnsbl.dronebl.org",
120 "rbl.efnetrbl.org"
121 ]);
122
123 /** Your email settings
124 * Requires plugin "php_mailer"
125 */
126 define('EMAIL_SETTINGS', [
127 "host" => 'smtp.host.example.com',
128 "port" => 587,
129 "encryption" => 'tls', /* Use 'tls' for STARTTLS or 'ssl' for TLS/SSL */
130 "username" => "youremail@example.com", /* The email to login with and send emails from */
131 "password" => "supersecretpassword", /* The password for the above email */
132 "from_name" => "UnrealIRCd Admin Panel",
133
134 ]);