]> jfr.im git - irc/unrealircd/unrealircd-webpanel.git/blame - config/config.php.sample
Make new settings-in-config work for file-based db as well.
[irc/unrealircd/unrealircd-webpanel.git] / config / config.php.sample
CommitLineData
26971737
VP
1<?php
2
3/**
4 * The configuration file for your admin panel.
5 *
6 */
7
ea90b321 8if (!defined('UPATH'))
6257bda1 9 die("Access denied");
26971737 10
27efe895
BM
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*/
ea90b321 17$config["base_url"] = '/unrealircd-webpanel/';
26971737
VP
18
19/**
20 * The RPC User name as defined in your unrealircd.conf
f22f79e0 21 * https://www.unrealircd.org/docs/UnrealIRCd_webpanel#Configuring_UnrealIRCd
26971737 22*/
ea90b321 23$config["unrealircd"]["rpc_user"] = 'adminpanel';
26971737
VP
24
25/**
26 * The RPC User password as defined in your unrealircd.conf
27*/
ea90b321 28$config["unrealircd"]["rpc_password"] = 'securepassword';
26971737
VP
29
30/**
31 * The host IP or name of your RPC server
32*/
ea90b321 33$config["unrealircd"]["host"] = '127.0.0.1';
26971737
VP
34
35/**
36 * The port of your RPC server as defined in your unrealircd.conf
37*/
ea90b321 38$config["unrealircd"]["port"] = '8600';
26971737
VP
39
40/**
0b163f47 41 * You should set this to true, if your RPC server is not on your local host
26971737 42*/
ea90b321 43$config["unrealircd"]["tls_verify_cert"] = false;
26971737
VP
44
45/**
0b163f47 46 * You should only need this, if you're developing something.
26971737 47*/
ea90b321 48$config["debug"] = false;
90dc8f2b 49
b65f4469
VP
50/**
51 * Your list of plugins:
52 */
0576a3f9 53$config["plugins"] = [
6257bda1
VP
54 /* This is where you should type the name(s) of your plugins.
55 * Uncomment the following line to view the live example
56 */
57 //"example_plugin", /* An example plugin */
d74b3a6d 58 //"file_auth", /* Provides a login page - uses a db file */
6257bda1 59 //"sql_auth", /* Provides a login page which uses SQL */
c44f6efa 60 //"php_mailer", /* Provides ability to send emails on behalf of the admin panel */
252b3431 61 ];
b65f4469 62
d74b3a6d
BM
63/* If you want a simple file-based database, and you have enabled
64 * "file_auth" in plugins above, then make sure your data/ directory
65 * is writable by the www user! Usually you need something like:
66 * chown www-data:www-data /var/www/html/webpanel/data/ -R
67 */
68
69/**
70 * If you load any of the auth plugins the first time, then this
71 * will create a "default user" as soon as you load the webpanel.
72 * Define a username and password here, start the webpanel, and
73 * after you have successfully logged in, remove the define here again:
74 */
75//define('DEFAULT_USER', [
76// "username" => "default",
77// "password" => "testing"
78//]);
90dc8f2b 79
5d8e394e 80/**
b65f4469 81 * If you wish to use the SQL user authentication system "sql_auth",
5d8e394e
VP
82 * you'll need to specify your SQL information below.
83 */
84
85 /**
86 * SQL IP address or hostname
2db8e178
VP
87 * You may specify a unix domain socket directory address
88 * E.g:
0576a3f9 89 * $config["mysql"]["host"] = "/path/to/unix/domain/socket";
2db8e178
VP
90 *
91 * Path to unix socket MUST start with a slash "/"
5d8e394e 92 */
ea90b321 93//$config["mysql"]["host"] = "127.0.0.1";
5d8e394e
VP
94
95/**
96 * SQL Dabase name
97 */
ea90b321
BM
98//$config["mysql"]["database"] = "unrealircdwebpanel";
99
5d8e394e
VP
100/**
101 * SQL Username
102 */
ea90b321 103//$config["mysql"]["username"] = "unrealircdwebpanel";
5d8e394e
VP
104
105/**
106 * SQL Password
107 */
ea90b321 108//$config["mysql"]["password"] = "replace_this_with_your_sql_password";
5d8e394e
VP
109
110/**
111 * SQL Table prefix
112 * You should only need to change this if you have already have one
113 * or more instances of webpanel on the same database
114 */
ea90b321 115//$config["mysql"]["table_prefix"] = "unreal_";
5d8e394e
VP
116
117
ce9cf366
VP
118/**
119 * Also part of the SQL_Auth plugin. This protects your login page.
120 * This is a list of DNS Blacklists that get checked for non-logged-in
121 * users.
122*/
c51d17f4 123//$config["dnsbl"] = ["dnsbl.dronebl.org", "rbl.efnetrbl.org"];
c44f6efa
VP
124
125/** Your email settings
126 * Requires plugin "php_mailer"
127*/
135ba4d7
BM
128$config["smtp"]["host"] = "127.0.0.1";
129$config["smtp"]["port"] = 587;
130$config["smtp"]["encryption"] = "tls"; /* Use 'tls' for STARTTLS or 'ssl' for TLS/SSL */
e4efe329
BM
131$config["smtp"]["username"] = "youremail@example.com"; /* The email to login with and send emails from */
132$config["smtp"]["password"] = "supersecretpassword"; /* The password for the above email */
135ba4d7 133$config["smtp"]["from_name"] = "UnrealIRCd Admin Panel";