Skip to content

Commit a8678c9

Browse files
authored
Merge pull request #149 from VillagerBoyGitHub/main
Fulfilled task 148 and made a few minor improvements
2 parents 76ec45a + eb2f279 commit a8678c9

7 files changed

Lines changed: 37 additions & 35 deletions

File tree

docs/getting-started/_parts/install/os/debian.mdx

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" | tee /etc/apt
4242

4343
# Add Redis official APT repository
4444
curl -fsSL https://packages.redis.io/gpg | gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg
45-
echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list
4645

47-
# MariaDB repo setup script
46+
# Run these commands if you're not on Debian 13
47+
echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list
4848
curl -LsS https://r.mariadb.com/downloads/mariadb_repo_setup | bash
4949

5050
# Update repositories list
@@ -54,7 +54,7 @@ apt update -y
5454
apt install -y php8.3 php8.3-{common,cli,gd,mysql,mbstring,bcmath,xml,fpm,curl,zip,intl,redis} mariadb-server nginx git redis-server
5555
```
5656

57-
If you are using redis for your system, you will want to make sure to enable that it will start on boot. You can do that by running the following command:
57+
If you are using redis for your system, you will need to enable it on boot. You can do that by running the following command:
5858

5959
```bash
6060
systemctl enable --now redis-server
@@ -105,6 +105,4 @@ chmod -R 755 storage/* bootstrap/cache/
105105

106106
<NavigateToWeb />
107107

108-
<DeleteInstaller />
109-
110-
export const toc = []
108+
export const toc = []

docs/getting-started/_parts/install/steps/queue-listeners.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
### Crontab Configuration
44

5-
The first thing we need to do is create a new cron job that runs every minute to process specific Dashboard tasks such as billing users hourly and suspending unpaid servers. To setup crontab, we first have to open it. To do so, run the following command:
5+
The first thing we need to do is create a new cronjob that runs every minute to process specific Dashboard tasks such as billing users hourly and suspending unpaid servers. To setup crontab, we first have to open it. To do so, run the following command:
66

77
```bash
88
crontab -e
99
```
1010

11-
If it prompts you for a file editor, choose number 1. Once It's opened, go to a line that doesn't have a `#` in front of it. Then paste in this:
11+
If it prompts you for a file editor, choose number 1. Once It's opened, go to a line that doesn't have a `#` in front of it. Then paste the following line:
1212

1313
```bash
1414
* * * * * php /var/www/ctrlpanel/artisan schedule:run >> /dev/null 2>&1
@@ -44,4 +44,4 @@ Finally, enable the service and set it to boot on machine start.
4444

4545
```bash
4646
sudo systemctl enable --now ctrlpanel.service
47-
```
47+
```

docs/getting-started/install.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ import UbuntuInstall from './_parts/install/os/ubuntu.mdx';
1111
# Installation
1212

1313
:::danger
14-
Creating a hosting is a serious responsibility, including **legal liability** - it requires solid knowledge of **network infrastructure**, **Linux systems**, and related technologies.
15-
If you don't know what you're doing, **don't do it**.
14+
Creating a hosting company is a serious responsibility, including **legal liability** - it requires solid knowledge of **network infrastructure**, **Linux systems**, and related technologies.
15+
If you don't know what you're doing, **don't do it**. Please, before you install and use this dashboard, for your customers' sake, and for your sake, **gain some Linux knowledge**.
1616

1717
We also reserve the right to deny you support on our Discord server if you lack at least basic technical knowledge or understanding of what you're doing.
18+
19+
Having mentioned this, we can proceed with the installation.
1820
:::
1921

20-
Installing CtrlPanel is fairly straightforward and not much different from setting up Pterodactyl. Our documentation is written for Debian-based systems. Be sure to read the comments for each command carefully, they often contain important information!
22+
Installing CtrlPanel is fairly straightforward and not much different to setting up Pterodactyl. Our documentation is written for Debian-based systems. Be sure to read the comments for each command carefully, they often contain important information!
2123

2224
<Tabs groupId="os" queryString>
2325
<TabItem value="debian" label="Debian" >
@@ -26,4 +28,4 @@ Installing CtrlPanel is fairly straightforward and not much different from setti
2628
<TabItem value="ubuntu" label="Ubuntu">
2729
<UbuntuInstall />
2830
</TabItem>
29-
</Tabs>
31+
</Tabs>

docs/guides/themes.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ There have been reports that this section doesn’t work. It is currently unmain
1313
### Basic setup
1414

1515
Ctrlpanel.gg uses the module [laravel-themer](https://github.com/qirolab/laravel-themer).
16-
To start creating your own theme run the following command
16+
To start creating your own theme run the following command:
1717

1818
```bash
1919
php artisan make:theme
2020
```
2121

22-
This will ask you some basic questions and will setup a base for you to start with.
22+
Once you do this, the script will ask you some basic questions and will set up a base for you to start with.
2323

2424
### Bladefiles & layout
2525

docs/guides/uninstall.mdx

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,16 @@ import TabItem from "@theme/TabItem";
88
# Uninstall
99

1010
:::warning
11-
You will loose all data that you have stored in your Ctrlpanel.
11+
You will lose all data that you have stored in your Ctrlpanel.
1212

13-
**Note:** This will only work if you followed our documentation, you might need to modify the commands to fit your installation.
13+
**Before you start**
14+
- This will only work if you have carefully followed our documentation.
15+
- You might need to modify the commands to fit your installation.
1416
:::
1517

1618
## Stop everything
1719

18-
You need to stop ctrlpanel and all of its services before you can uninstall it.
20+
Before deleting anything, you need to stop CtrlPanel and all of its services.
1921

2022
```bash
2123
cd /var/www/ctrlpanel
@@ -24,11 +26,11 @@ sudo php artisan down
2426
sudo systemctl stop ctrlpanel
2527
```
2628

27-
## Remove
29+
## Delete files
2830

2931
### Service and cronjob
3032

31-
You have to stop and remove the service and cronjob.
33+
You have to stop and remove the services and cronjobs.
3234

3335
```bash
3436
sudo systemctl stop ctrlpanel
@@ -38,15 +40,15 @@ sudo systemctl daemon-reload
3840
sudo systemctl reset-failed
3941
```
4042

41-
To open the crontab run: `crontab -e` and remove the following configuration from crontab.
43+
To open crontab, please run `crontab -e` and remove the following configuration from crontab.
4244

4345
```bash
4446
* * * * * php /var/www/ctrlpanel/artisan schedule:run >> /dev/null 2>&1
4547
```
4648

4749
### Webconfig and SSL certificates
4850

49-
Now you need to remove the webconfig and restart it
51+
Once you've done this, you need to remove the webserver configuration and restart it.
5052

5153
<Tabs groupId="webserver">
5254
<TabItem value="Nginx" label="Nginx" >
@@ -65,15 +67,15 @@ Now you need to remove the webconfig and restart it
6567
</TabItem>
6668
</Tabs>
6769

68-
Don't forget about SSL certificates
70+
Don't forget to delete SSL certificates.
6971

7072
```bash
7173
sudo certbot delete --cert-name <Your Domain>
7274
```
7375

7476
### Database and User
7577

76-
Now you need to remove the database and user:
78+
Now that you've deleted the webserver files, you need to remove the database and user:
7779

7880
<Tabs groupId="db">
7981
<TabItem value="MySQL" label="MySQL" >
@@ -103,16 +105,16 @@ Now you need to remove the files.
103105
```bash
104106
sudo rm -rf /var/www/ctrlpanel
105107
```
108+
# Optional
106109

107-
### Extra Dependency
108-
109-
You need to uninstall this, use the appropriate PHP version (php -v)
110+
### Extra Dependency
111+
CtrlPanel should now be uninstalled. If you want to fully clean your server, please run the following commands.
112+
You need to uninstall PHP. Make sure to check your PHP version before you do this.
110113

111114
```bash
112115
sudo apt remove php8.3-{intl,redis}
113116
```
114117

115118
### Pterodactyl API Key
116-
117-
Login to your pterodactyl panel and go to the admin page.
118-
Then go to the API tab (`/admin/api`) and delete the key you made for ctrlpanel.
119+
Login to your Pterodactyl panel and go to the admin page.
120+
Then go to the API tab (`/admin/api`) and delete the key you made for CtrlPanel.

docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ You can visit our demo panel [here](https://demo.ctrlpanel.gg)
7070

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

73-
Looking for a good server? Purchase one from our partner with promo code **[CtrlPanel](https://zap-hosting.com/CtrlPanel)** to receive a **20% discount**. Click [here](https://zap-hosting.com/CtrlPanel) to get started.
73+
Looking for a good server? Purchase one from our partner with promo code **[CtrlPanel](https://zap-hosting.com/CtrlPanel)** to receive a **20% discount**!

readme.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Ctrlpanel.gg Docs
1+
# CtrlPanel.gg Docs
22
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
33

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

2323
## Deployment
24-
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.
24+
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.
2525
You can also deploy it manualy by clicking [Run workflow](https://github.com/ControlPanel-gg/docs/actions/workflows/deploy.yml) here.

0 commit comments

Comments
 (0)