]>
Commit | Line | Data |
---|---|---|
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 ## | |
0f498c3d | 7 | - PHP 8 or later |
922a4534 VP |
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 | ||
f217c52a BM |
18 | - Go to your webserver root, for example `/var/www/html/`, and clone |
19 | this repository: | |
922a4534 | 20 | ``` |
f217c52a BM |
21 | cd /var/www/html |
22 | git clone https://github.com/ValwareIRC/unrealircd-webpanel | |
922a4534 VP |
23 | ``` |
24 | ||
f217c52a BM |
25 | - Go into the directory and run composer to install the dependencies |
26 | (If you don't have composer, then [install it](https://getcomposer.org/download/) first): | |
7e236785 | 27 | ``` |
f217c52a | 28 | cd unrealircd-webpanel |
7e236785 BM |
29 | composer install |
30 | ``` | |
7e236785 | 31 | |
f217c52a | 32 | - Edit the configuration file |
922a4534 | 33 | ``` |
e7192278 | 34 | cp config.php.sample config.php |
922a4534 VP |
35 | nano config.php |
36 | ``` | |
37 | The file will look like this:<br> | |
38 | <img src="https://i.ibb.co/zZ7LsXD/Screenshot-from-2023-01-04-17-03-20.png"> | |
39 | ||
40 | Edit the configuration file to match your UnrealIRCd's RPC credentials and save | |
41 | ||
f217c52a BM |
42 | NOTE: You most likely want to put the webpanel behind a login, using a |
43 | `.htaccess` file or similar. | |
aef43f9e BM |
44 | |
45 | ## Updating for end-users ## | |
46 | For end-users, when you want to update to the latest version: | |
47 | ```bash | |
48 | git pull | |
49 | composer update | |
50 | ``` | |
51 | ||
52 | ## Developers ## | |
53 | Developers of the webpanel will naturally use the same procedure as | |
54 | above. However, sometimes you will want to update to a newer version | |
55 | of the unrealircd-rpc-php library. You then need to run: | |
56 | ```bash | |
57 | # For devs only! | |
58 | composer install | |
59 | git commit composer.lock | |
60 | ``` | |
61 | Commiting the composer.lock file updates the dependency for all | |
62 | other users, that way a `composer update` by end-users will update | |
63 | to exactly the version that `composer install` just installed. |