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