[Feature] Update and Refactor the Github and Doc (#947)
This commit is contained in:
Dennis
GitHub
commit
159ba02c84
42
.env.example
42
.env.example
|
|
@ -4,25 +4,24 @@ APP_ENV=production
|
|||
APP_KEY=
|
||||
APP_DEBUG=false
|
||||
APP_URL=http://localhost
|
||||
# List with timezones https://www.php.net/manual/en/timezones.php
|
||||
APP_TIMEZONE=UTC
|
||||
APP_TIMEZONE=UTC # List with timezones https://www.php.net/manual/en/timezones.php
|
||||
### --- App Settings End --- ###
|
||||
|
||||
### --- DB Settings (required) --- ###
|
||||
### --- Database Settings (required) --- ###
|
||||
DB_CONNECTION=mysql
|
||||
DB_HOST=127.0.0.1
|
||||
DB_PORT=3306
|
||||
DB_DATABASE=dashboard
|
||||
DB_USERNAME=dashboarduser
|
||||
DB_PASSWORD=
|
||||
### --- DB Settings End --- ###
|
||||
### --- Database Settings End --- ###
|
||||
|
||||
|
||||
# Google Recaptcha API Credentials - https://www.google.com/recaptcha/admin - reCaptcha V2 (not v3)
|
||||
### --- Google Recaptcha Settings --- ###
|
||||
RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
|
||||
RECAPTCHA_SECRET_KEY=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe
|
||||
### --- Google Recaptcha Settings End --- ###
|
||||
|
||||
# Mail Server Settings - (HOST -> SMTP Server)
|
||||
### --- Mail Server Settings --- ###
|
||||
MAIL_MAILER=smtp
|
||||
MAIL_HOST=mailhog
|
||||
MAIL_PORT=1025
|
||||
|
|
@ -31,25 +30,22 @@ MAIL_PASSWORD=null
|
|||
MAIL_ENCRYPTION=null
|
||||
MAIL_FROM_ADDRESS=null
|
||||
MAIL_FROM_NAME="${APP_NAME}"
|
||||
### --- Mail Server Settings End --- ###
|
||||
|
||||
|
||||
# Laravel Logging Settings - https://laravel.com/docs/5.7/logging - Not needed to be changed
|
||||
### --- Logging Settings --- ###
|
||||
LOG_CHANNEL=stack
|
||||
LOG_LEVEL=debug
|
||||
### --- Logging Settings End --- ###
|
||||
|
||||
# Do not change anything below this line
|
||||
BROADCAST_DRIVER=log
|
||||
### --- Cache and Queue Settings --- ###
|
||||
CACHE_DRIVER=file
|
||||
QUEUE_CONNECTION=database
|
||||
SESSION_DRIVER=file
|
||||
SESSION_LIFETIME=120
|
||||
SETTINGS_CACHE_ENABLED=true
|
||||
### --- Cache and Queue Settings End --- ###
|
||||
|
||||
MEMCACHED_HOST=127.0.0.1
|
||||
|
||||
REDIS_HOST=127.0.0.1
|
||||
REDIS_PASSWORD=null
|
||||
REDIS_PORT=6379
|
||||
|
||||
### --- External Services Credentials --- ###
|
||||
AWS_ACCESS_KEY_ID=
|
||||
AWS_SECRET_ACCESS_KEY=
|
||||
AWS_DEFAULT_REGION=us-east-1
|
||||
|
|
@ -59,9 +55,15 @@ PUSHER_APP_ID=
|
|||
PUSHER_APP_KEY=
|
||||
PUSHER_APP_SECRET=
|
||||
PUSHER_APP_CLUSTER=mt1
|
||||
### --- External Services Credentials End --- ###
|
||||
|
||||
### --- Additional Configuration --- ###
|
||||
MEMCACHED_HOST=127.0.0.1
|
||||
|
||||
REDIS_HOST=127.0.0.1
|
||||
REDIS_PASSWORD=null
|
||||
REDIS_PORT=6379
|
||||
|
||||
MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
|
||||
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
|
||||
|
||||
# Settings Cache
|
||||
SETTINGS_CACHE_ENABLED=true
|
||||
### --- Additional Configuration End --- ###
|
||||
|
|
|
|||
5
.gitattributes
vendored
5
.gitattributes
vendored
|
|
@ -1,5 +1,10 @@
|
|||
# Automatically detect text files
|
||||
* text=auto
|
||||
|
||||
# Vendored files for specific languages
|
||||
*.css linguist-vendored
|
||||
*.scss linguist-vendored
|
||||
*.js linguist-vendored
|
||||
|
||||
# Ignore CHANGELOG.md when exporting
|
||||
CHANGELOG.md export-ignore
|
||||
|
|
|
|||
22
.github/CODE_OF_CONDUCT.md
vendored
Normal file
22
.github/CODE_OF_CONDUCT.md
vendored
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
## Code of Conduct
|
||||
|
||||
### 🤝 Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
### 🌟 Our Standards
|
||||
Examples of behavior that contributes to creating a positive environment include:
|
||||
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
34
.github/CONTRIBUTING.md
vendored
Normal file
34
.github/CONTRIBUTING.md
vendored
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
# Contributing Guidelines
|
||||
|
||||
Thank you for considering contributing to this repository! Before making a contribution, please take a moment to review the following guidelines.
|
||||
|
||||
## 🕵️♂️ Finding Tasks
|
||||
|
||||
Check the open issues to see if there's something you can contribute to. If you have an idea or encounter a bug that's not already listed, feel free to create a new issue and wait for feedback from the development team.
|
||||
|
||||
## 🤝 Code of Conduct
|
||||
|
||||
Please adhere to our [Code of Conduct](https://github.com/Ctrlpanel-gg/panel/blob/main/.github/CODE_OF_CONDUCT.md) in all your interactions with the project.
|
||||
|
||||
## 🌍 Localization
|
||||
|
||||
If you add any strings that are displayed on the frontend, please localize them using the following format:
|
||||
```
|
||||
"New String" -> {{ __('New String') }}
|
||||
```
|
||||
After adding localized strings, run the following command to generate localization files:
|
||||
```cmd
|
||||
php artisan translatable:export en
|
||||
```
|
||||
|
||||
## 🚀 Pull Request Process
|
||||
|
||||
1. Give your pull request (PR) a clear and descriptive title that summarizes the changes.
|
||||
2. The development team will review your code and provide feedback or approve/merge it when appropriate.
|
||||
3. Ensure that your PR follows our Code of Conduct and coding style guidelines.
|
||||
|
||||
### 💻 Coding Style
|
||||
|
||||
We follow the PSR12 code standard for PHP.
|
||||
|
||||
Thank you for your contributions! 🎉
|
||||
2
.github/ISSUE_TEMPLATE/bug.yml
vendored
2
.github/ISSUE_TEMPLATE/bug.yml
vendored
|
|
@ -1,6 +1,6 @@
|
|||
name: "\U0001F41B Bug report"
|
||||
description: Create a report to help us improve
|
||||
title: "[Bug]: "
|
||||
title: "[Bug] "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: textarea
|
||||
|
|
|
|||
37
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
37
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
✨ Thank you for your contribution to our project! Before you submit your pull request, please take a moment to review and complete the following
|
||||
|
||||
⚠️ Please modify this template below and if not already done, read our pull request rules, Thanks!
|
||||
|
||||
Ensure that your pull request meets the following criteria:
|
||||
|
||||
- The code follows the style guidelines of this project
|
||||
- You have performed a self-review of your own code and tested it
|
||||
- You have commented your code, particularly in hard-to-understand areas
|
||||
- Your changes generate no new warnings
|
||||
|
||||
Delete the above text and the following sections before submitting your pull request.
|
||||
|
||||
---
|
||||
|
||||
💡 **Description**
|
||||
|
||||
Briefly describe the purpose of your pull request, including any relevant issue numbers it addresses.
|
||||
|
||||
---
|
||||
|
||||
🛠️ **Type of Change**
|
||||
|
||||
Please select the appropriate type of change:
|
||||
|
||||
- Bug fix (non-breaking change which fixes an issue)
|
||||
- User interface (UI) improvement
|
||||
- New feature (non-breaking change which adds functionality)
|
||||
- Breaking change (a fix or feature that would cause existing functionality to not work as expected)
|
||||
- Other
|
||||
- This change requires a documentation update
|
||||
|
||||
---
|
||||
|
||||
🖼️ **Screenshots (if applicable)**
|
||||
|
||||
If your pull request includes any visual changes, please provide screenshots here, do not use any external link.
|
||||
17
.github/SECURITY.md
vendored
Normal file
17
.github/SECURITY.md
vendored
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# Security Policy
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
🛡️ If you discover a security vulnerability, please report it to us via GitHub Advisories.
|
||||
|
||||
⚠️ Please refrain from using the public issue tracker or discussing the vulnerability in public channels, as it may exacerbate the issue.
|
||||
|
||||
## Acceptance of Bug Bounty Platforms
|
||||
|
||||
At this time, we only accept vulnerability reports through GitHub Advisories. We kindly ask that you do not submit reports via other third-party bug bounty platforms, as they will be disregarded.
|
||||
|
||||
## Supported Versions
|
||||
|
||||
### ControlPanel Versions
|
||||
|
||||
We strongly recommend using or upgrading to the latest version of ControlPanel to ensure you have access to the latest security fixes and enhancements.
|
||||
35
.gitignore
vendored
35
.gitignore
vendored
|
|
@ -1,29 +1,34 @@
|
|||
# Ignore dependencies and cache
|
||||
/node_modules
|
||||
/vendor
|
||||
/storage/*.key
|
||||
|
||||
# Ignore public assets
|
||||
/public/hot
|
||||
/public/storage
|
||||
/storage/*.key
|
||||
/vendor
|
||||
/storage/credit_deduction_log
|
||||
storage/debugbar
|
||||
/storage/app/public/logo.png
|
||||
|
||||
# Ignore environment files and configuration
|
||||
.env
|
||||
.env.testing
|
||||
.env.backup
|
||||
.idea
|
||||
.env.dev
|
||||
|
||||
# Ignore testing and debug logs
|
||||
.phpunit.result.cache
|
||||
.editorconfig
|
||||
docker-compose.override.yml
|
||||
Homestead.json
|
||||
Homestead.yaml
|
||||
npm-debug.log
|
||||
yarn-error.log
|
||||
yarn.lock
|
||||
|
||||
# Ignore Docker and Homestead configuration
|
||||
docker-compose.override.yml
|
||||
Homestead.json
|
||||
Homestead.yaml
|
||||
|
||||
# Ignore gitignore itself
|
||||
.gitignore
|
||||
.env.dev
|
||||
.env.testing
|
||||
storage/invoices.zip
|
||||
storage/app/public/logo.png
|
||||
*vscode
|
||||
- Kopie.env
|
||||
|
||||
# Ignore installation logs and locks
|
||||
public/install/logs.txt
|
||||
install.lock
|
||||
public/install/logs/installer.log
|
||||
|
|
|
|||
|
|
@ -1,43 +0,0 @@
|
|||
# Contributing
|
||||
|
||||
When contributing to this repository, please go through the open issues to see if you can contribute to something. If you want to contribute something that is not in the issues you can make an issue and wait for response from the dev team.
|
||||
|
||||
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
||||
|
||||
If you added any Strings which are displayed at the frontend please localize them (e.g. "New String" -> {{ __('New String') }}) and run the localization string generation:
|
||||
|
||||
```cmd
|
||||
php artisan translatable:export en
|
||||
```
|
||||
|
||||
## Pull request process
|
||||
|
||||
1. Give your PR a good descriptive title, so we can view immediately what the PR is about.
|
||||
2. The dev team will look at your code and approve / merge when possible.
|
||||
3. Make sure your PR follows our code of conduct and coding style.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
### Our Pledge
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
### Coding Style
|
||||
|
||||
We are following the PSR12 code standard for PHP.
|
||||
|
||||
### Our Standards
|
||||
Examples of behavior that contributes to creating a positive environment include:
|
||||
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
106
README.md
106
README.md
|
|
@ -1,67 +1,87 @@
|
|||
### Features
|
||||
|
||||
- PayPal, Stripe and Mollie Integration
|
||||
- Hourly, Weekely, Monthly, Quarterly and Annual billing Cycles
|
||||
- Referral System
|
||||
- Partner System
|
||||
- Ticket System
|
||||
- Upgrade/Downgrade Server Resources
|
||||
- Store (credit system with hourly billing and invoices)
|
||||
- Email Verification
|
||||
- Audit Log
|
||||
- Admin Dashboard
|
||||
- User/Server Management
|
||||
- Customisable server plans
|
||||
- Vouchers
|
||||
- Alert System
|
||||
- Theme Support
|
||||
- and so much more!
|
||||
<div align="center">
|
||||
<img src="https://ctrlpanel.gg/img/controlpanel.png" width="128" alt="" />
|
||||
</div>
|
||||
|
||||
# CtrlPanel-gg
|
||||
|
||||
|
||||
CtrlPanel offers an easy-to-use and free billing solution for all starting and experienced hosting providers that seamlessly integrates with the Pterodactyl panel. It facilitates account creation, server ordering, and management, while offering addons, multiple payment methods, and customizable themes for a comprehensive solution.
|
||||
|
||||
|
||||
|
||||
|
||||
[](https://crowdin.com/project/controlpanelgg)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
   [](https://crowdin.com/project/controlpanelgg)   
|
||||
## About
|
||||
|
||||
|
||||
CtrlPanel's Dashboard is a dashboard application designed to offer clients a management tool to manage their pterodactyl servers. This dashboard comes with a credit-based billing solution that charges users depending on the billing cycle you chose for each server they have and suspends them if they run out of credits.
|
||||
## ⭐ Features
|
||||
|
||||
This dashboard offers an easy to use and free billing solution for all starting and experienced hosting providers. This dashboard has many customisation options and added discord Oauth verification to offer a solid link between your discord server and your dashboard. You can check our [Demo here](https://demo.CtrlPanel.gg "Demo").
|
||||
- Store (credit system with hourly billing and invoices)
|
||||
- Many Popular Payment Methods
|
||||
- Referral
|
||||
- Partner
|
||||
- Vouchers
|
||||
- Ticket
|
||||
- Account Management
|
||||
- Admin Dashboard and Tools
|
||||
- Addon Support
|
||||
- and more!
|
||||
|
||||
### [Installation](https://ctrlpanel.gg/docs/intro "Installation")
|
||||
## ⛰️ Live Demo
|
||||
|
||||
### [Updating](https://ctrlpanel.gg/docs/Installation/updating "Updating")
|
||||
Try it!
|
||||
|
||||
### [Discord](https://discord.gg/4Y6HjD2uyU "Discord")
|
||||
Demo Server: [demo.CtrlPanel.gg](https://demo.CtrlPanel.gg)
|
||||
|
||||
### [Contributing](https://ctrlpanel.gg/docs/Contributing/contributing "Contributing")
|
||||
<!-- It is a temporary live demo; all data will be deleted. -->
|
||||
|
||||
### [Donating](https://ctrlpanel.gg/docs/Contributing/donating "Donating")
|
||||
## 🔧 How to Install
|
||||
|
||||
### 🐳 Docker
|
||||
|
||||
Soon...
|
||||
|
||||
# Preview
|
||||
<!-- ```bash
|
||||
docker run ...
|
||||
```
|
||||
|
||||
### Server Creation
|
||||
|
||||
CtrlPanel is now running on [0.0.0.0:3001](http://0.0.0.0:3001). Don't forget to configure the database and Pterodactyl. [Documentation](documentation link here)
|
||||
|
||||
### Overview
|
||||
|
||||
more info: [Docker](docker documentation link here) -->
|
||||
|
||||
### Example server products
|
||||
|
||||
### 💪🏻 Non-Docker
|
||||
|
||||
### Ticket System
|
||||
|
||||
Requirements:
|
||||
|
||||
### Voucher System
|
||||
|
||||
- Platform
|
||||
- Major Linux distros such as Debian, Ubuntu, CentOS, Fedora, and ArchLinux etc.
|
||||
- Windows 10 (x64), Windows Server ...
|
||||
|
||||
### Partner System
|
||||
|
||||
Follow the [documentation](https://ctrlpanel.gg/docs/intro) to know how to install.
|
||||
|
||||
### MarketPlace
|
||||
|
||||
If you need more functionality, check out [Marketplace](https://market.ctrlpanel.gg/resources/).
|
||||
|
||||
## 🆙 How to Update
|
||||
|
||||
Please read: [Update Instructions](https://ctrlpanel.gg/docs/Installation/updating)
|
||||
|
||||
## 🆕 What's Next?
|
||||
|
||||
Roadmap: [CtrlPanel Roadmap](https://github.com/orgs/Ctrlpanel-gg/projects/1)
|
||||
|
||||
## 🗣️ Discussion / Ask for Help
|
||||
|
||||
For any general or technical questions, join CtrlPanel Discord for finding answers to your question. If you cannot find the information you need, feel free to ask.
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Please read [CONTRIBUTING.md](https://github.com/Ctrlpanel-gg/panel/blob/main/.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
|
||||
|
||||
Thanks to all contributors and supporters!
|
||||
|
||||
## ♥️ Donations
|
||||
|
||||
If you like what we do, please consider [supporting](https://ctrlpanel.gg/docs/Contributing/donating) us.
|
||||
|
|
|
|||
Loading…
Reference in a new issue