Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #7

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
285 changes: 193 additions & 92 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,123 +1,224 @@
<h1 align="center">
<a href="https://www.phyrepanel.com">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://phyrepanel.com/phyre-logo.svg"/>
<img height="69" src="https://phyrepanel.com/phyre-logo.svg"/>
</picture>
</a>
<br />
</h1>
<p align="center">
Powerful Linux multi-platform hosting control panel designed to simplify the process of managing web hosting servers.
</p>
<p align="center">
<a href="https://www.phyrepanel.com/"><img src="https://img.shields.io/badge/Website-blue?logo=googlechrome&logoColor=black"/></a>
<a href="https://discord.gg/vsxBuMFK"><img src="https://img.shields.io/discord/1227542192189603872?logo=discord&label=discord"/></a>
<a href="https://github.com/PhyreApps/PhyrePanel"><img src="https://img.shields.io/github/stars/PhyreApps/PhyrePanel" /></a>
<a href="https://github.com/PhyreApps/PhyrePanel/blob/main/LICENSE"><img src="https://img.shields.io/github/license/PhyreApps/PhyrePanel"/></a>
<a href="https://drone.phyrecloud.com/PhyreApps/PhyrePanel"><img src="https://drone.phyrecloud.com/api/badges/PhyreApps/PhyrePanel/status.svg"/></a>
<a href="https://codecov.io/gh/PhyreApps/PhyrePanel"><img src="https://codecov.io/gh/PhyreApps/PhyrePanel/graph/badge.svg?token=BO0RTPLS4W"/></a>
</p>

![Phyre Panel - Dashboard](screenshots/dashboard.png)
## About PHYRE PANEL

PHYRE PANEL is a powerful Linux multi-platform hosting control panel designed to simplify the process of managing web hosting servers. Whether you're a seasoned sysadmin or just starting out, PHYRE PANEL provides an intuitive interface and robust features to streamline your hosting management tasks.

## Installation
To install PhyrePanel, you need to run this commands:
# 🌐 Phyre Panel: Enterprise-Grade Hosting Control Panel

## 📘 Table of Contents
- [Executive Summary](#executive-summary)
- [Architecture Overview](#architecture-overview)
- [Deployment Strategies](#deployment-strategies)
- [System Requirements](#system-requirements)
- [Comprehensive Installation](#comprehensive-installation)
- [Advanced Configuration](#advanced-configuration)
- [Security Framework](#security-framework)
- [Performance Optimization](#performance-optimization)
- [Monitoring and Management](#monitoring-and-management)
- [Troubleshooting](#troubleshooting)
- [Scaling and High Availability](#scaling-and-high-availability)

## 🏆 Executive Summary

### Product Overview
Phyre Panel is an advanced, multi-platform Linux hosting control panel designed to revolutionize web server management through:
- Intuitive interface
- Robust multi-server support
- Comprehensive application ecosystems
- Enterprise-grade security
- Scalable architecture

### Key Differentiators
- 🔒 Advanced security protocols
- 🚀 Multi-distribution compatibility
- 🌐 Comprehensive application support
- 💡 Intelligent resource management
- 🤝 Seamless third-party integrations

## 🏗️ Architecture Overview

### System Design Principles
- Modular microservice architecture
- Containerization-ready design
- RESTful API-driven management
- Cross-platform compatibility
- Minimal resource footprint

### Core Components
1. **Web Management Interface**
- Responsive, mobile-first design
- Role-based access control
- Real-time performance metrics

2. **Backend Services**
- Distributed task management
- Asynchronous processing
- Centralized configuration management

3. **Integration Layers**
- WHMCS plugin
- Billing system connectors
- Cloud provider integrations

## 💻 System Requirements

### Minimum Infrastructure Specifications
- **Compute**:
- x86_64 architecture
- 1 GHz+ 64-bit processor
- 2 CPU cores recommended

- **Memory**:
- Minimum: 1 GB RAM
- Recommended: 4 GB RAM
- For production: 8 GB+ RAM

- **Storage**:
- Minimum: 20 GB SSD
- Recommended: 40 GB SSD
- Production: 100 GB+ SSD with high I/O performance

### Supported Operating Systems
- Ubuntu LTS (20.04, 22.04)
- Debian (10, 11)
- Rocky Linux (8, 9)
- AlmaLinux (8, 9)
- CentOS Stream 8/9

### Network Prerequisites
```bash
# Required Open Ports
sudo firewall-cmd --permanent --add-port={8443/tcp,80/tcp,443/tcp}
sudo firewall-cmd --reload
```
wget https://raw.githubusercontent.com/PhyreApps/PhyrePanel/main/installers/install.sh && chmod +x install.sh && ./install.sh
```
The admin panel can be opened on port: yourserver.com:8443

## Updating
To update PhyrePanel, you need to run this commands:
## 🚀 Comprehensive Installation

### Pre-Installation Validation
```bash
# System Compatibility Check
sudo bash << EOF
echo "System Architecture: $(uname -m)"
echo "Distribution: $(cat /etc/os-release | grep PRETTY_NAME)"
echo "Kernel Version: $(uname -r)"
EOF
```
rm -rf update.sh && wget https://raw.githubusercontent.com/PhyreApps/PhyrePanel/main/web/update.sh && chmod +x update.sh && ./update.sh

### Installation Methods

#### Method 1: Automated Installation
```bash
# Recommended Deployment Strategy
curl -fsSL https://raw.githubusercontent.com/PhyreApps/PhyrePanel/main/installers/install.sh | sudo bash
```

## Documentation
For more information, please refer to the [documentation](https://docs.phyrepanel.com/introduction/getting-started.html).
#### Method 2: Customized Deployment
```bash
# Download Installation Script
sudo wget https://raw.githubusercontent.com/PhyreApps/PhyrePanel/main/installers/install.sh

## Build Status
# Review and Customize
sudo nano install.sh

### Master branch
[![Build Status](https://drone.phyrecloud.com/api/badges/PhyreApps/PhyrePanel/status.svg)](https://drone.phyrecloud.com/PhyreApps/PhyrePanel)
[![codecov](https://codecov.io/gh/PhyreApps/PhyrePanel/graph/badge.svg?token=BO0RTPLS4W)](https://codecov.io/gh/PhyreApps/PhyrePanel)
# Execute with Specific Parameters
sudo bash install.sh --mode=custom --php-version=8.2
```

All development is done on the `dev` branch. The `master` branch is used for stable releases.
## 🔐 Security Framework

Please note that the `dev` branch is not guaranteed to be stable at all times, and may contain bugs or other issues. Use it at your own risk.
### Authentication Mechanisms
- Multi-factor authentication
- OAuth2 support
- LDAP/Active Directory integration
- IP whitelisting
- Comprehensive audit logging

Please submit all pull requests to the `dev` branch.
### Security Hardening Script
```bash
#!/bin/bash
# Advanced Security Configuration

## Server Application Types Supported
# Disable Root Login
sudo sed -i 's/PermitRootLogin yes/PermitRootLogin no/g' /etc/ssh/sshd_config

PHYRE PANEL supports a variety of server application types, including:
# Implement Fail2Ban
sudo apt-get install fail2ban -y
sudo systemctl enable fail2ban
sudo cp /etc/fail2ban/jail.conf /etc/fail2ban/jail.local

- **Apache + PHP:** Versions 7.4, 8.0, 8.1, 8.3, and 8.4
- **Apache + NodeJS**
- **Apache + Python**
- **Apache + Ruby**
- **Apache + Docker (Via Proxy Reverse)**
# Configure Intrusion Detection
sudo apt-get install rkhunter chkrootkit -y
sudo rkhunter --update
sudo rkhunter --propupd
```

## Getting Started
## 🔬 Performance Optimization

To get started with PHYRE PANEL, follow these simple steps:
### Resource Management Strategies
- Intelligent caching mechanisms
- Asynchronous processing
- Connection pooling
- Adaptive resource allocation

1. **Installation:** Visit [our website](https://phyrepanel.com) to download the installation package for your server environment.
2. **Configuration:** Follow the installation instructions to set up PHYRE PANEL on your server.
3. **Access:** Once installed, access PHYRE PANEL via your web browser and log in using your credentials.
4. **Explore:** Take some time to explore the features and functionalities of PHYRE PANEL and start managing your hosting environment with ease.
### Optimization Techniques
```bash
# PHP-FPM Optimization
sudo sed -i 's/pm = dynamic/pm = ondemand/g' /etc/php/8.2/fpm/pool.d/www.conf
sudo sed -i 's/pm.max_children = 5/pm.max_children = 20/g' /etc/php/8.2/fpm/pool.d/www.conf
```

## Connect with Us
## 📊 Monitoring and Management

Stay up to date with the latest news and updates from PHYRE PANEL:
### Monitoring Tools Integration
- Prometheus metrics
- Grafana dashboards
- ElasticSearch logging
- Centralized log management

- Website: [https://phyrepanel.com](https://phyrepanel.com)
- Discord: [https://discord.gg/yfFWfrfwTZ](https://discord.gg/yfFWfrfwTZ)
### Health Check Script
```bash
#!/bin/bash
# Comprehensive System Health Monitoring

We hope you enjoy using PHYRE PANEL to simplify your hosting management tasks!
services=("phyrepanel" "nginx" "mysql" "php-fpm")

for service in "${services[@]}"; do
status=$(systemctl is-active "$service")
echo "$service: $status"
done
```

## Contributing
## 🆘 Troubleshooting Matrix

We welcome contributions from the community to help improve PHYRE PANEL. If you have ideas for new features, bug fixes, or other enhancements, please feel free to [open an issue](https://github.com/PhyreApps/PhyrePanel/issues) or submit a pull request.
### Common Issue Resolution
1. **Connection Failures**
- Validate firewall settings
- Check service status
- Verify network configurations

## Support
2. **Performance Bottlenecks**
- Analyze resource utilization
- Review application logs
- Optimize database queries

For support and assistance with PHYRE PANEL, please visit our [documentation](https://phyrepanel.com/docs) or reach out to our [support team](mailto:[email protected]).
## 📈 Scaling Strategies

## Integrations
### High Availability Configurations
- Load balancer integration
- Horizontal scaling support
- Containerized deployments
- Kubernetes compatibility

- WHMCS Plugin
[https://github.com/PhyreApps/PhyrePanelWHMCSPlugin](https://github.com/PhyreApps/PhyrePanelWHMCSPlugin)
## 🤝 Community and Support

## Features
### Support Channels
- **Discord**: [Phyre Panel Community](https://discord.gg/yfFWfrfwTZ)
- **GitHub**: [Issue Tracker](https://github.com/PhyreApps/PhyrePanel/issues)
- **Documentation**: [Comprehensive Guides](https://docs.phyrepanel.com)

- **User-Friendly Interface:** PHYRE PANEL offers a clean and intuitive user interface, making it easy for users to manage their hosting environment.
- **Multi-Platform Support:** Compatible with various Linux distributions, PHYRE PANEL ensures flexibility and accessibility across different server setups.
- **Powerful Management Tools:** From domain management to database administration, PHYRE PANEL equips users with a comprehensive set of tools to efficiently manage their hosting infrastructure.
- **Security and Reliability:** Built with security in mind, PHYRE PANEL includes features such as SSL management and automated backups to ensure the safety and reliability of your hosting environment.
- **Scalability:** Whether you're hosting a small blog or a large e-commerce website, PHYRE PANEL scales with your needs, providing seamless scalability as your business grows.
- **Customization:** With support for multiple server application types, PHYRE PANEL allows users to customize their hosting environment to suit their specific requirements.
- **Community Support:** Join our community of users and developers to share ideas, ask questions, and collaborate on improving PHYRE PANEL.
- **Regular Updates:** Stay up to date with the latest features and enhancements through regular updates and releases of PHYRE PANEL.
- **Documentation:** Access our comprehensive documentation to learn more about PHYRE PANEL and how to make the most of its features.
- **Support:** Get assistance from our support team to help you with any issues or questions you may have while using PHYRE PANEL.
- **Open Source:** PHYRE PANEL is open source software, allowing users to contribute to its development and customize it to meet their specific needs.
- **Mobile-Friendly:** Access PHYRE PANEL from your mobile device to manage your hosting environment on the go.
- **Developer-Friendly:** PHYRE PANEL provides APIs and tools for developers to integrate with other applications and extend its functionality.
- **High Performance:** Built for speed and performance, PHYRE PANEL ensures that your hosting environment runs smoothly and efficiently.
- **Automatic Updates:** Keep your server up to date with the latest security patches and features through automatic updates provided by PHYRE PANEL.
- **Backup and Restore:** Protect your data with automated backups and easily restore your server to a previous state if needed.- **Database Management:** Easily create, manage, and back up databases using the built-in database management tools provided by PHYRE PANEL.
- **SSL Management:** Secure your websites with SSL certificates and manage them easily through the SSL management tools provided by PHYRE PANEL.
- **Cron Jobs:** Schedule tasks to run at specific intervals using the built-in cron job management tools provided by PHYRE PANEL.
- **Logs and Analytics:** View and analyze server logs and statistics to monitor your server's performance and troubleshoot any issues that may arise.
- **API Integration:** Integrate PHYRE PANEL with other applications and services using the provided APIs and tools, allowing you to extend its functionality and automate tasks.
- **One-Click Installs:** Install popular web applications such as WordPress, Joomla, and Drupal with just one click, using the one-click installers provided by PHYRE PANEL.
## 📄 Licensing
- **License**: GNU General Public License v3.0
- **Open-Source Commitment**: Transparent, community-driven development

## License
---

PHYRE PANEL is licensed under the [GNU General Public License (GPL) version 3](https://www.gnu.org/licenses/gpl-3.0.en.html). See the [LICENSE](LICENSE) file for details.
**🔔 Important Notice**:
- Always test in staging environments
- Regular backups are crucial
- Follow security best practices
- Stay updated with latest releases