Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
6f228b5
Fix typos and improve clarity in README
VillagerBoyGitHub Dec 7, 2025
5d3e271
Clarify theme creation instructions
VillagerBoyGitHub Dec 7, 2025
de2fce4
Fix typos and enhance clarity
VillagerBoyGitHub Dec 7, 2025
f8ecfba
Clean up intro.md slightly
VillagerBoyGitHub Dec 7, 2025
bd362a3
Update installation warnings and instructions
VillagerBoyGitHub Dec 7, 2025
a10fde8
Fixed optional repos for Debian 13
VillagerBoyGitHub Dec 8, 2025
082e631
Fixed grammar and clarity
VillagerBoyGitHub Dec 8, 2025
eb2f279
Merge branch 'main' into main
VillagerBoyGitHub Mar 27, 2026
83e15a4
Merge pull request #151 from Ctrlpanel-gg/main
MrWeez Mar 31, 2026
76ec45a
chore: :bookmark: preparing for new release
MrWeez Mar 31, 2026
a8678c9
Merge pull request #149 from VillagerBoyGitHub/main
MrWeez Mar 31, 2026
78a8f83
chore: :pencil2: revert to old "Hosting responsibility" message
MrWeez Mar 31, 2026
457c44b
chore: prep for new v1.2 beta release
Mar 31, 2026
19401c3
Clarify settings cache rebuild instructions
simbabimba-dev Mar 31, 2026
5e04ac9
revert: restore archived 1.1.x docs
Apr 1, 2026
e760df0
chore: update installation instructions and clarify OS support in doc…
Apr 1, 2026
4e0bf03
more fixes
Apr 2, 2026
e721f1d
Merge pull request #152 from simbabimba-dev/development
MrWeez Apr 2, 2026
bc05440
refactor: :pencil2: minor improvements
MrWeez Apr 2, 2026
5f32237
feat: :art: better structure and beta version docs
MrWeez Apr 2, 2026
ae96104
fix: :bug: no sidebar for 1.2.x docs
MrWeez Apr 2, 2026
aad71cd
ci: :green_heart: trying to fix test build
MrWeez Apr 2, 2026
e41ffbf
ci: :green_heart: fix CI build
MrWeez Apr 2, 2026
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
7 changes: 3 additions & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,12 @@ jobs:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v6
- uses: actions/setup-node@v6
with:
node-version: 18.x
node-version: 21
cache: yarn
- name: Build website
working-directory: docs
run: |
yarn install
yarn build
Expand Down
7 changes: 3 additions & 4 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,12 @@ jobs:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v6
- uses: actions/setup-node@v6
with:
node-version: 18.x
node-version: 21
cache: yarn
- name: Test build
working-directory: docs
run: |
yarn install
yarn build
17 changes: 12 additions & 5 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,22 @@ module.exports = {
"@docusaurus/preset-classic",
{
docs: {
lastVersion: "current",
includeCurrentVersion: false,
lastVersion: "1.1.x",
versions: {
current: {
'beta': {
label: '1.2.x (Public Beta)',
path: 'beta',
banner: 'none',
},
// '1.2.x': {
// label: '1.2.x (Upcoming release)',
// },
'1.1.x': {
label: '1.1.x (Latest)',
// path: 'development',
},
archive: {
'archive': {
label: 'Archive',
// path: 'development',
},
},
// Please change this to your repo.
Expand Down
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Ctrlpanel.gg Docs
# CtrlPanel.gg Docs
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

# Contributing
Follow these steps when contributing to this repository:
1: Fork this repository
Please follow these steps when contributing to this repository:
1: Fork the repository
2: Make your changes
3: Open a PR from your fork to the development branch
4: Wait for the workflow to verify your modification can build with success
Expand All @@ -21,5 +21,5 @@ yarn start
```

## Deployment
This is automated, every push to the main branch into the /docs directory will trigger the deployment workflow and host the side via GitHub pages.
Deployment is automated: every push to the main branch into the /docs directory will trigger the deployment workflow and host the side via GitHub pages.
You can also deploy it manualy by clicking [Run workflow](https://github.com/ControlPanel-gg/docs/actions/workflows/deploy.yml) here.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 10 additions & 0 deletions versioned_docs/version-1.2.x/contributing/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"position": 4,
"label": "Contributing",
"collapsed": true,
"link": {
"type": "generated-index",
"title": "Contributing",
"description": "Want to support the project but not sure how? We'll tell you all about it here"
}
}
49 changes: 49 additions & 0 deletions versioned_docs/version-1.2.x/contributing/donating.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
sidebar_position: 1
---

# Donating

Love using ctrlpanel.gg? Support us to keep improving! 🌟 Enjoy perks like premium support & a unique Discord role! 💖
[Patreon](https://www.patreon.com/1day2die) | [Ko-fi](https://ko-fi.com/1day2die) | [GitHub Sponsors](https://github.com/sponsors/Ctrlpanel-gg)

Your donations go a long way in helping us develop CtrlPanel, but please don't feel obligated to.<br/>
I will try to mention any donation above 1€ in our Discord server.

## Donator Roles

**Sapphire** >= 100 $/€<br/>
**Ruby Supporter** >= 50 $/€<br/>
**Gold Supporter** >= 25 $/€<br/>
**Silver Supporter** >= 15 $/€<br/>
**Bronze Supporter** >= 5 $/€ <br/>
_All Donators with a supporter role will also have access to a Donators Only channel and premium support_

_Please notify me when you've donated, so I can respond quicker :) **1day2die**_

## Donators

❤️ Ruby Supporter: **p47thiccbolt#4836**<br/>
❤️ Ruby Supporter: **BolverBlitz#4881**<br/>
❤️ Ruby Supporter: **ccrs#4120**<br/>
❤️ Ruby Supporter: **Timo#4042**<br/>
❤️ Ruby Supporter: **Sir Maddigan#0243**<br/>

💛 Gold Supporter: **Wynn#1000**<br/>
💛 Gold Supporter: **dragocz#0191**<br/>
💛 Gold Supporter: **Niktix#3749** [TIX-Hosting](https://tix-hosting.net/)<br/>
💛 Gold Supporter: **DerHorschty#3855**<br/>

🤍 Silver Supporter: **TheFrodoDE#1337**<br/>

🤎 Bronze Supporter: **Grosenberger#5417**<br/>
🤎 Bronze Supporter: **ojacz#5091**<br/>
🤎 Bronze Supporter: **Coconut#7171**<br/>
🤎 Bronze Supporter: **Bazim#0485**<br/>
🤎 Bronze Supporter: **Jonas.#9915**<br/>
🤎 Bronze Supporter: **Vysoký Vagón#3796**<br/>
🤎 Bronze Supporter: **I got 2 phones#8225**<br/>
🤎 Bronze Supporter: **2IceCube#7992**<br/>
🤎 Bronze Supporter: **ᴅᴏᴍɪɴɪᴋ#1005**<br/>
🤎 Bronze Supporter: **DWAA#1660**<br/>
🤎 Bronze Supporter: **ukcai#7121**<br/>
17 changes: 17 additions & 0 deletions versioned_docs/version-1.2.x/contributing/partners.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_position: 4
---

# Partners

We are deeply grateful to the organizations and individuals whose generous support makes this project possible. Below is a showcase of our partners, each displayed with a banner or logo and a brief description. Their support enables us to maintain and improve our project infrastructure and develop new features and enhancements.

Thank you to all our partners for believing in our vision and helping us drive innovation forward!

## ZAP-Hosting

[![ZAP-Hosting Gameserver and Web Hosting](https://zap-hosting.com/interface/download/images.php?type=affiliate&id=421578)](https://zap-hosting.com/a/29b1c37a4f87bde5463afe8a0f49d129b16ccf9e)

Looking for reliable, high-quality hosting? ZAP-Hosting offers rentals or lifetime purchases of game servers, Linux and Windows VPS, root servers, and dedicated servers.

Use promo code **[CtrlPanel](https://zap-hosting.com/CtrlPanel)** when placing your order to receive a **20% discount**. Get started [here](https://zap-hosting.com/CtrlPanel).
17 changes: 17 additions & 0 deletions versioned_docs/version-1.2.x/contributing/reporting.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_position: 2
---

# Reporting

## Found a bug you can consistently reproduce?
We'd love for you to report it on [Issues](https://github.com/Ctrlpanel-gg/panel/issues) section of our panel repository. We aim to fix all bugs based on priority.

## Have an idea for a useful or interesting feature?
Please create an [Issue](https://github.com/Ctrlpanel-gg/panel/issues) on our GitHub as well!

## Discovered a critical vulnerability?
Report it immediately via [GitHub Security Advisories](https://github.com/Ctrlpanel-gg/panel/security/advisories/new). Also, send a direct message to `1day2die` in discord.

We strongly ask you to keep the vulnerability confidential until the official fix and announcement are released.
Avoid discussing vulnerabilities in public chats, and also do not create reports on public trackers!
9 changes: 9 additions & 0 deletions versioned_docs/version-1.2.x/contributing/translating.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 3
---

# Translating

:::warning
We are currently planning a complete refactor and improvement of the translation system, which will be released with version 1.2.0. Because of this, this section is not in use for now.
:::
10 changes: 10 additions & 0 deletions versioned_docs/version-1.2.x/development/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"position": 4,
"label": "Development",
"collapsed": true,
"link": {
"type": "generated-index",
"title": "Development",
"description": "Do you want to try out new features that haven't been released yet or help us find bugs? Or maybe even help fix some bug?"
}
}
30 changes: 30 additions & 0 deletions versioned_docs/version-1.2.x/development/back-to-release.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
sidebar_position: 3
---

# Rolling back to the release version

Unfortunately, it highly depends on the situation.

If you just installed the **development** version, have a database backup, and want to roll back do this:

```bash
git checkout main
git pull
```

Next, follow the instructions for [restoring](/docs/guides/backup?db-state=existing#how-to-restore-database-backup) your database backup.

---

If a stable release is available and you're on development but behind, run:
```bash
git checkout main
git pull
```

and follow the default upgrade guide

## Still need help?

Reach out to us on [our Discord](https://discord.gg/ctrlpanel-gg-787829714483019826) server in the support channel! We'll do our best to help you.
9 changes: 9 additions & 0 deletions versioned_docs/version-1.2.x/development/install.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 1
---

# Installing development version

:::info
Version 1.2.0 is in early development, and there are no changes compared to the [standard installation](/docs/getting-started/install) process. You can simply follow the regular installation guide, just clone the `development` branch instead of `main`.
:::
82 changes: 82 additions & 0 deletions versioned_docs/version-1.2.x/development/upgrade.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
sidebar_position: 2
---

# Update to development version

:::danger
Always backup your database and any code changes before updating! It's better to not need them, than to lose everything when you do. We've explained how to do that [here](/docs/guides/backup).

Without a backup, you won't be able to roll back without losing all your data.
:::

## Enable Maintenance Mode

```bash
cd /var/www/ctrlpanel
php artisan down
```

## Switching to development branch

```bash
git checkout development
```

## Pulling the New Files

```bash
git stash
git pull
chmod -R 755 /var/www/ctrlpanel
```

## Update Dependencies

```bash
COMPOSER_ALLOW_SUPERUSER=1 composer install --no-dev --optimize-autoloader
```

## Updating the Database

```bash
php artisan migrate --seed --force
```

## Clear Compiled Template Cache

```bash
php artisan view:clear
php artisan config:clear
```

## Set Permissions

```bash
# If using NGINX or Apache (not on CentOS):
chown -R www-data:www-data /var/www/ctrlpanel/

# If using NGINX on CentOS:
chown -R nginx:nginx /var/www/ctrlpanel/

# If using Apache on CentOS
chown -R apache:apache /var/www/ctrlpanel/
```

## Restarting Queue Workers

After every update, you should restart the queue worker to ensure that the new code is loaded in and used.

```bash
php artisan queue:restart
```

## Disable Maintenance Mode

```bash
php artisan up
```

## Disclaimer

If you notice any bugs 🐛 or would like something to be improved or added, let us know by making a [GitHub Issue](https://github.com/CtrlPanel-gg/panel/issues/new/choose).<br /> **For any major security risk, create** [GitHub vulnerability report](https://github.com/Ctrlpanel-gg/panel/security/advisories/new). Avoid discussing vulnerabilities in public chats, and also do not create reports on public trackers!
10 changes: 10 additions & 0 deletions versioned_docs/version-1.2.x/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"position": 2,
"label": "Getting started",
"collapsed": false,
"link": {
"type": "generated-index",
"title": "Getting started",
"description": "Alright, let's get started with the installation and configuration!"
}
}
Loading