ctrlpanel/README.md

<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.

![GitHub tag](https://img.shields.io/github/tag/ControlPanel-gg/dashboard)
![Overall Installations](https://img.shields.io/badge/Overall%20Installations-5000%2B-green)
![GitHub stars](https://img.shields.io/github/stars/ControlPanel-gg/dashboard)
[![Crowdin](https://badges.crowdin.net/controlpanelgg/localized.svg)](https://crowdin.com/project/controlpanelgg)
![License](https://img.shields.io/github/license/ControlPanel-gg/dashboard)
![Discord](https://img.shields.io/discord/787829714483019826)

![CtrlPanel](https://user-images.githubusercontent.com/67899387/214684708-739c1d21-06e8-4dec-a4f1-81533a46cc7e.png)

## ⭐ Features

- 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!

## ⛰️ Live Demo

Try it!

Demo Server: [demo.CtrlPanel.gg](https://demo.CtrlPanel.gg)

<!-- It is a temporary live demo; all data will be deleted. -->

## 🔧 How to Install

### 🐳 Docker

Soon...

<!-- ```bash
docker run ...
```

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)

more info: [Docker](docker documentation link here) -->

### 💪🏻 Non-Docker

Requirements:

- Platform
  - Major Linux distros such as Debian, Ubuntu, CentOS, Fedora, and ArchLinux etc.
  - Windows 10 (x64), Windows Server ...

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.