]> jfr.im git - irc/unrealircd/unrealircd-webpanel.git/blame - config/config.php.sample
Add data/ directory that will be used later
[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 */
58 //"sql_auth", /* Provides a login page which uses SQL */
c44f6efa 59 //"php_mailer", /* Provides ability to send emails on behalf of the admin panel */
252b3431 60 ];
b65f4469 61
90dc8f2b 62
5d8e394e 63/**
b65f4469 64 * If you wish to use the SQL user authentication system "sql_auth",
5d8e394e
VP
65 * you'll need to specify your SQL information below.
66 */
67
68 /**
69 * SQL IP address or hostname
2db8e178
VP
70 * You may specify a unix domain socket directory address
71 * E.g:
0576a3f9 72 * $config["mysql"]["host"] = "/path/to/unix/domain/socket";
2db8e178
VP
73 *
74 * Path to unix socket MUST start with a slash "/"
5d8e394e 75 */
ea90b321 76//$config["mysql"]["host"] = "127.0.0.1";
5d8e394e
VP
77
78/**
79 * SQL Dabase name
80 */
ea90b321
BM
81//$config["mysql"]["database"] = "unrealircdwebpanel";
82
5d8e394e
VP
83/**
84 * SQL Username
85 */
ea90b321 86//$config["mysql"]["username"] = "unrealircdwebpanel";
5d8e394e
VP
87
88/**
89 * SQL Password
90 */
ea90b321 91//$config["mysql"]["password"] = "replace_this_with_your_sql_password";
5d8e394e
VP
92
93/**
94 * SQL Table prefix
95 * You should only need to change this if you have already have one
96 * or more instances of webpanel on the same database
97 */
ea90b321 98//$config["mysql"]["table_prefix"] = "unreal_";
5d8e394e
VP
99
100
75e5eb62
VP
101/**
102 * The default user for the plugin "SQL_Auth". As soon as you load
103 * the plugin, the user defined below will be created. It suggested
104 * that you remove it after you've logged in successfully.
105 */
ea90b321
BM
106//define('SQL_DEFAULT_USER', [
107// "username" => "default",
108// "password" => "testing"
109//]);
ce9cf366
VP
110
111/**
112 * Also part of the SQL_Auth plugin. This protects your login page.
113 * This is a list of DNS Blacklists that get checked for non-logged-in
114 * users.
115*/
c51d17f4 116//$config["dnsbl"] = ["dnsbl.dronebl.org", "rbl.efnetrbl.org"];
c44f6efa
VP
117
118/** Your email settings
119 * Requires plugin "php_mailer"
120*/
135ba4d7
BM
121$config["smtp"]["host"] = "127.0.0.1";
122$config["smtp"]["port"] = 587;
123$config["smtp"]["encryption"] = "tls"; /* Use 'tls' for STARTTLS or 'ssl' for TLS/SSL */
e4efe329
BM
124$config["smtp"]["username"] = "youremail@example.com"; /* The email to login with and send emails from */
125$config["smtp"]["password"] = "supersecretpassword"; /* The password for the above email */
135ba4d7 126$config["smtp"]["from_name"] = "UnrealIRCd Admin Panel";