diff --git a/docs/getting-started/_parts/install/os/debian.mdx b/docs/getting-started/_parts/install/os/debian.mdx index 3b5855a..9254b26 100644 --- a/docs/getting-started/_parts/install/os/debian.mdx +++ b/docs/getting-started/_parts/install/os/debian.mdx @@ -41,9 +41,9 @@ echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" | tee /etc/apt # Add Redis official APT repository curl -fsSL https://packages.redis.io/gpg | gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg -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 -# MariaDB repo setup script +# Run these commands if you're not on Debian 13 +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 curl -LsS https://r.mariadb.com/downloads/mariadb_repo_setup | bash # Update repositories list @@ -53,7 +53,7 @@ apt update -y 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 ``` -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: +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: ```bash systemctl enable --now redis-server @@ -104,4 +104,4 @@ chmod -R 755 storage/* bootstrap/cache/ -export const toc = [] \ No newline at end of file +export const toc = [] diff --git a/docs/getting-started/_parts/install/steps/queue-listeners.mdx b/docs/getting-started/_parts/install/steps/queue-listeners.mdx index 7ec7298..d839a67 100644 --- a/docs/getting-started/_parts/install/steps/queue-listeners.mdx +++ b/docs/getting-started/_parts/install/steps/queue-listeners.mdx @@ -2,13 +2,13 @@ ### Crontab Configuration -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: +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: ```bash crontab -e ``` -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: +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: ```bash * * * * * 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. ```bash sudo systemctl enable --now ctrlpanel.service -``` \ No newline at end of file +``` diff --git a/docs/getting-started/install.mdx b/docs/getting-started/install.mdx index 4f8fd21..a2eaa21 100644 --- a/docs/getting-started/install.mdx +++ b/docs/getting-started/install.mdx @@ -11,13 +11,15 @@ import UbuntuInstall from './_parts/install/os/ubuntu.mdx'; # Installation :::danger -Creating a hosting is a serious responsibility, including **legal liability** - it requires solid knowledge of **network infrastructure**, **Linux systems**, and related technologies. -If you don't know what you're doing, **don't do it**. +Creating a hosting company is a serious responsibility, including **legal liability** - it requires solid knowledge of **network infrastructure**, **Linux systems**, and related technologies. +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**. 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. + +Having mentioned this, we can proceed with the installation. ::: -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! +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! @@ -26,4 +28,4 @@ Installing CtrlPanel is fairly straightforward and not much different from setti - \ No newline at end of file + diff --git a/docs/guides/themes.mdx b/docs/guides/themes.mdx index 5dc208d..0b4ecf1 100644 --- a/docs/guides/themes.mdx +++ b/docs/guides/themes.mdx @@ -13,13 +13,13 @@ There have been reports that this section doesn’t work. It is currently unmain ### Basic setup Ctrlpanel.gg uses the module [laravel-themer](https://github.com/qirolab/laravel-themer). -To start creating your own theme run the following command +To start creating your own theme run the following command: ```bash php artisan make:theme ``` -This will ask you some basic questions and will setup a base for you to start with. +Once you do this, the script will ask you some basic questions and will set up a base for you to start with. ### Bladefiles & layout diff --git a/docs/guides/uninstall.mdx b/docs/guides/uninstall.mdx index d29b01c..a98b91a 100644 --- a/docs/guides/uninstall.mdx +++ b/docs/guides/uninstall.mdx @@ -8,14 +8,16 @@ import TabItem from "@theme/TabItem"; # Uninstall :::warning -You will loose all data that you have stored in your Ctrlpanel. +You will lose all data that you have stored in your Ctrlpanel. -**Note:** This will only work if you followed our documentation, you might need to modify the commands to fit your installation. +**Before you start** +- This will only work if you have carefully followed our documentation. +- You might need to modify the commands to fit your installation. ::: ## Stop everything -You need to stop ctrlpanel and all of its services before you can uninstall it. +Before deleting anything, you need to stop CtrlPanel and all of its services. ```bash cd /var/www/ctrlpanel @@ -24,11 +26,11 @@ sudo php artisan down sudo systemctl stop ctrlpanel ``` -## Remove +## Delete files ### Service and cronjob -You have to stop and remove the service and cronjob. +You have to stop and remove the services and cronjobs. ```bash sudo systemctl stop ctrlpanel @@ -38,7 +40,7 @@ sudo systemctl daemon-reload sudo systemctl reset-failed ``` -To open the crontab run: `crontab -e` and remove the following configuration from crontab. +To open crontab, please run `crontab -e` and remove the following configuration from crontab. ```bash * * * * * php /var/www/ctrlpanel/artisan schedule:run >> /dev/null 2>&1 @@ -46,7 +48,7 @@ To open the crontab run: `crontab -e` and remove the following configuration fro ### Webconfig and SSL certificates -Now you need to remove the webconfig and restart it +Once you've done this, you need to remove the webserver configuration and restart it. @@ -65,7 +67,7 @@ Now you need to remove the webconfig and restart it -Don't forget about SSL certificates +Don't forget to delete SSL certificates. ```bash sudo certbot delete --cert-name @@ -73,7 +75,7 @@ sudo certbot delete --cert-name ### Database and User -Now you need to remove the database and user: +Now that you've deleted the webserver files, you need to remove the database and user: @@ -103,16 +105,16 @@ Now you need to remove the files. ```bash sudo rm -rf /var/www/ctrlpanel ``` +# Optional -### Extra Dependency - -You need to uninstall this, use the appropriate PHP version (php -v) +### Extra Dependency +CtrlPanel should now be uninstalled. If you want to fully clean your server, please run the following commands. +You need to uninstall PHP. Make sure to check your PHP version before you do this. ```bash sudo apt remove php8.3-{intl,redis} ``` ### Pterodactyl API Key - -Login to your pterodactyl panel and go to the admin page. -Then go to the API tab (`/admin/api`) and delete the key you made for ctrlpanel. +Login to your Pterodactyl panel and go to the admin page. +Then go to the API tab (`/admin/api`) and delete the key you made for CtrlPanel. diff --git a/docs/intro.md b/docs/intro.md index 6031963..e5d4d8b 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -70,4 +70,4 @@ You can visit our demo panel [here](https://demo.ctrlpanel.gg) [![ZAP-Hosting Gameserver and Webhosting](https://zap-hosting.com/interface/download/images.php?type=affiliate&id=421578)](https://zap-hosting.com/a/29b1c37a4f87bde5463afe8a0f49d129b16ccf9e) -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. \ No newline at end of file +Looking for a good server? Purchase one from our partner with promo code **[CtrlPanel](https://zap-hosting.com/CtrlPanel)** to receive a **20% discount**! diff --git a/readme.md b/readme.md index c4f7bf2..9333108 100644 --- a/readme.md +++ b/readme.md @@ -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 @@ -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.