]> jfr.im git - irc/unrealircd/unrealircd-webpanel.git/blob - config/config.php.sample
Newconf: smtp / mailer
[irc/unrealircd/unrealircd-webpanel.git] / config / 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 $config["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 $config["unrealircd"]["rpc_user"] = 'adminpanel';
24
25 /**
26 * The RPC User password as defined in your unrealircd.conf
27 */
28 $config["unrealircd"]["rpc_password"] = 'securepassword';
29
30 /**
31 * The host IP or name of your RPC server
32 */
33 $config["unrealircd"]["host"] = '127.0.0.1';
34
35 /**
36 * The port of your RPC server as defined in your unrealircd.conf
37 */
38 $config["unrealircd"]["port"] = '8600';
39
40 /**
41 * You should set this to true, if your RPC server is not on your local host
42 */
43 $config["unrealircd"]["tls_verify_cert"] = false;
44
45 /**
46 * You should only need this, if you're developing something.
47 */
48 $config["debug"] = false;
49
50 /**
51 * Your list of plugins:
52 */
53 define(
54 'get_config("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('get_config("mysql::host")', "/path/to/unix/domain/socket");
76 *
77 * Path to unix socket MUST start with a slash "/"
78 */
79 //$config["mysql"]["host"] = "127.0.0.1";
80
81 /**
82 * SQL Dabase name
83 */
84 //$config["mysql"]["database"] = "unrealircdwebpanel";
85
86 /**
87 * SQL Username
88 */
89 //$config["mysql"]["username"] = "unrealircdwebpanel";
90
91 /**
92 * SQL Password
93 */
94 //$config["mysql"]["password"] = "replace_this_with_your_sql_password";
95
96 /**
97 * SQL Table prefix
98 * You should only need to change this if you have already have one
99 * or more instances of webpanel on the same database
100 */
101 //$config["mysql"]["table_prefix"] = "unreal_";
102
103
104 /**
105 * The default user for the plugin "SQL_Auth". As soon as you load
106 * the plugin, the user defined below will be created. It suggested
107 * that you remove it after you've logged in successfully.
108 */
109 //define('SQL_DEFAULT_USER', [
110 // "username" => "default",
111 // "password" => "testing"
112 //]);
113
114 /**
115 * Also part of the SQL_Auth plugin. This protects your login page.
116 * This is a list of DNS Blacklists that get checked for non-logged-in
117 * users.
118 */
119 //$config["dnsbl"] = ["dnsbl.dronebl.org", "rbl.efnetrbl.org"];
120
121 /** Your email settings
122 * Requires plugin "php_mailer"
123 */
124 $config["smtp"]["host"] = "127.0.0.1";
125 $config["smtp"]["port"] = 587;
126 $config["smtp"]["encryption"] = "tls"; /* Use 'tls' for STARTTLS or 'ssl' for TLS/SSL */
127 $config["smtp"]["username"] = "youremail@example.com", /* The email to login with and send emails from */
128 $config["smtp"]["password"] = "supersecretpassword", /* The password for the above email */
129 $config["smtp"]["from_name"] = "UnrealIRCd Admin Panel";