]>
Commit | Line | Data |
---|---|---|
f334f536 VP |
1 | # unrealircd-webpanel |
2 | UnrealIRCd Administration WebPanel | |
1e35660c | 3 | |
cb398e4a | 4 | <img src="https://i.ibb.co/yP7tk6B/Screenshot-from-2023-01-10-17-54-01.png"> |
922a4534 VP |
5 | |
6 | ## Prerequisites ## | |
0f498c3d | 7 | - PHP 8 or later |
922a4534 | 8 | - A webserver |
475cb9a8 | 9 | - UnrealIRCd 6.0.6-git recommended. Minimal functionality available with UnrealIRCd 6.0.5. |
922a4534 | 10 | |
2f9ac14e VP |
11 | Note: PHP 8 may require special installation instructions. |
12 | Here are some instructions for: | |
13 | - [Ubuntu 20/22](https://linuxhint.com/install-php-8-ubuntu-22-04/) | |
14 | - [Debian](https://www.vultr.com/docs/how-to-install-php-8-on-debian-11/) | |
15 | - [CentOS](https://www.tecmint.com/install-php-8-on-centos/) | |
16 | ||
17 | For more installation methods for PHP 8, make a websearch for how to install PHP 8 on your operating system. | |
922a4534 VP |
18 | ## Installation ## |
19 | ||
20 | Note: This instructional assumes this is going to be hosted in the webroot directory `/var/www/` (html/) directory. | |
21 | You may want to hide this somehow. Well, you definitely should. I don't know how to do that though. Sorry. | |
22 | ||
23 | Please make sure you have [correctly setup UnrealIRCd for use with JSON-RPC](https://www.unrealircd.org/docs/JSON-RPC) before you continue. | |
24 | ||
f217c52a BM |
25 | - Go to your webserver root, for example `/var/www/html/`, and clone |
26 | this repository: | |
922a4534 | 27 | ``` |
f217c52a | 28 | cd /var/www/html |
964e17d3 | 29 | git clone https://github.com/unrealircd/unrealircd-webpanel |
922a4534 VP |
30 | ``` |
31 | ||
f217c52a BM |
32 | - Go into the directory and run composer to install the dependencies |
33 | (If you don't have composer, then [install it](https://getcomposer.org/download/) first): | |
7e236785 | 34 | ``` |
f217c52a | 35 | cd unrealircd-webpanel |
7e236785 BM |
36 | composer install |
37 | ``` | |
7e236785 | 38 | |
f217c52a | 39 | - Edit the configuration file |
922a4534 | 40 | ``` |
e7192278 | 41 | cp config.php.sample config.php |
922a4534 VP |
42 | nano config.php |
43 | ``` | |
44 | The file will look like this:<br> | |
45 | <img src="https://i.ibb.co/zZ7LsXD/Screenshot-from-2023-01-04-17-03-20.png"> | |
46 | ||
47 | Edit the configuration file to match your UnrealIRCd's RPC credentials and save | |
48 | ||
f217c52a BM |
49 | NOTE: You most likely want to put the webpanel behind a login, using a |
50 | `.htaccess` file or similar. | |
aef43f9e BM |
51 | |
52 | ## Updating for end-users ## | |
53 | For end-users, when you want to update to the latest version: | |
54 | ```bash | |
55 | git pull | |
56 | composer update | |
57 | ``` | |
58 | ||
59 | ## Developers ## | |
60 | Developers of the webpanel will naturally use the same procedure as | |
61 | above. However, sometimes you will want to update to a newer version | |
62 | of the unrealircd-rpc-php library. You then need to run: | |
63 | ```bash | |
64 | # For devs only! | |
65 | composer install | |
66 | git commit composer.lock | |
67 | ``` | |
68 | Commiting the composer.lock file updates the dependency for all | |
69 | other users, that way a `composer update` by end-users will update | |
70 | to exactly the version that `composer install` just installed. |