]> jfr.im git - irc/unrealircd/unrealircd-webpanel-plugins.git/blob - README.md
Update README.md
[irc/unrealircd/unrealircd-webpanel-plugins.git] / README.md
1 # UnrealIRCd WebPanel Plugins
2
3 ## WARNING: USE AT YOUR OWN RISK
4
5 ### Overview
6 Welcome to the UnrealIRCd WebPanel Plugins repository. This repository contains a collection of plugins for the UnrealIRCd WebPanel, made by the community with love, designed to enhance your experience and extend the functionality of your UnrealIRCd WebPanel.
7
8 ### Important Notice
9 **WARNING: USE AT YOUR OWN RISK**
10
11 These plugins are provided as-is and come with no guarantees or warranties. By using these plugins, you acknowledge and accept the potential risks involved. The developers and contributors of this repository are not responsible for any damages or issues that may arise from the use of these plugins.
12
13 ### Potential Risks
14 1. **Security Vulnerabilities**: Plugins may introduce security vulnerabilities that could be exploited by malicious actors.
15 2. **Data Loss**: Improper use or bugs within the plugins could result in loss of data.
16 3. **System Instability**: Plugins might cause your UnrealIRCd WebPanel or the underlying UnrealIRCd server to become unstable or crash.
17 4. **Compatibility Issues**: Not all plugins may be compatible with every version of UnrealIRCd WebPanel or UnrealIRCd.
18
19 ### Recommendations
20 - **Thoroughly Test**: Before deploying any plugin to a production environment, thoroughly test it in a development or staging environment.
21 - **Backup Your Data**: Always make sure to backup your data and configuration files before installing any new plugins.
22 - **Review Code**: If possible, review the source code of the plugins to understand their functionality and potential risks.
23 - **Stay Updated**: Keep your UnrealIRCd WebPanel, UnrealIRCd server, and plugins updated to the latest versions to mitigate known issues and vulnerabilities.
24
25 ### Installation
26 To install a plugin from the repository, you can find the "Add New" button in the Plugins section on the webpanel. If you are creating your own plugin, generally this involves copying the plugin files to the appropriate directory and configuring the UnrealIRCd WebPanel to recognize and use the plugin (`config/config.php`)
27
28 ### Contributing
29 If you would like to contribute to this repository, please fork the repo, make your changes, and submit a pull request. Contributions are welcome but please ensure that your code is well-documented and tested.
30
31 ### License
32 This repository is licensed under the GPLv3 License. All contributions to this repository must also be GPLv3 or later.
33
34 ### Disclaimer
35 The use of these plugins is entirely at your own risk. The maintainers of this repository are not liable for any negative consequences resulting from the use of these plugins. Always exercise caution and make informed decisions when integrating third-party plugins into your systems.
36
37 For any issues or questions, please open an issue in this repository or contact the maintainers directly.
38
39 Thank you for using UnrealIRCd WebPanel Plugins. Stay safe and happy coding!