]> jfr.im git - irc/unrealircd/unrealircd-webpanel.git/blob - README.md
Update README
[irc/unrealircd/unrealircd-webpanel.git] / README.md
1 # unrealircd-webpanel
2 UnrealIRCd Administration WebPanel
3
4 <img src="https://i.ibb.co/7jtddG4/Screenshot-from-2022-12-31-04-53-35.png">
5
6 ## Prerequisites ##
7 - PHP 7 or later
8 - A webserver
9 - UnrealIRCd 6.0.5
10
11 ## Installation ##
12
13 Note: This instructional assumes this is going to be hosted in the webroot directory `/var/www/` (html/) directory.
14 You may want to hide this somehow. Well, you definitely should. I don't know how to do that though. Sorry.
15
16 Please make sure you have [correctly setup UnrealIRCd for use with JSON-RPC](https://www.unrealircd.org/docs/JSON-RPC) before you continue.
17
18 - First, if you have just installed apache2 or something else, remove the `html` directory and navigate to `/var/www/`
19 ```
20 cd /var/www/
21 rm -rf html
22 ```
23
24 - Clone this repository to a new directory called `html`
25 ```
26 git clone https://github.com/ValwareIRC/unrealircd-webpanel html
27 ```
28
29 - Move into the `html` directory and edit the configuration file
30 ```
31 cd html
32 cp config.php.sample config.php
33 nano config.php
34 ```
35 The file will look like this:<br>
36 <img src="https://i.ibb.co/zZ7LsXD/Screenshot-from-2023-01-04-17-03-20.png">
37
38 Edit the configuration file to match your UnrealIRCd's RPC credentials and save
39