From 5dc5160f8ed13c6b6e1c30b2eae04f9debefb17b Mon Sep 17 00:00:00 2001 From: Pinga <121483313+getpinga@users.noreply.github.com> Date: Sun, 12 Nov 2023 12:58:42 +0200 Subject: [PATCH] Documentation cleanup --- INSTALL.md | 54 +++++++++++++++++++++++++++++++++++++++++++- automation/README.md | 1 - cp/README.md | 3 --- 3 files changed, 53 insertions(+), 5 deletions(-) delete mode 100644 automation/README.md delete mode 100644 cp/README.md diff --git a/INSTALL.md b/INSTALL.md index 6b85632..df6d084 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -122,7 +122,59 @@ systemctl enable caddy systemctl restart caddy ``` -## 10. RDE (Registry data escrow) configuration: +## 10. Initial Setup for Automation Scripts + +Before you continue, it is essential to configure the automation scripts properly. Please follow these steps to set up your environment: + +### Rename Configuration File: + +Locate the file named ```config.php.dist``` in the automation directory and rename it to ```config.php```. + +### Edit Configuration Settings: + +Open the file in a text editor and carefully review and update all the values to match your specific requirements. + +### Install Required Dependencies: + +Navigate to the automation directory in your command line interface. + +Execute the following command to install the necessary dependencies: + +```bash +composer require badcow/dns phpseclib/phpseclib +``` + +This command will install the ```badcow/dns``` and ```phpseclib/phpseclib``` packages which are essential for the automation script to function correctly. + +## 11. Control Panel Setup + +To set up the control panel, follow these instructions: + +### Configure Environment File: + +Locate the file named ```env-sample``` in the control panel (```cp```) directory. + +Rename this file to ```.env```. + +### Edit Environment Settings: + +Open the ```.env``` file in a text editor. + +Update the settings within this file to suit your specific environment and application needs. + +### Install Dependencies: + +Open your command line interface and navigate to the ```cp``` (control panel) directory. + +Run the following command to install the required dependencies: + +```bash +composer update +``` + +This command will update and install the dependencies defined in your ```composer.json``` file, ensuring that your control panel has all the necessary components to operate effectively. + +## 12. RDE (Registry data escrow) configuration: ### Generate the Key Pair: diff --git a/automation/README.md b/automation/README.md deleted file mode 100644 index 51238b9..0000000 --- a/automation/README.md +++ /dev/null @@ -1 +0,0 @@ -composer require badcow/dns phpseclib/phpseclib \ No newline at end of file diff --git a/cp/README.md b/cp/README.md deleted file mode 100644 index cff77af..0000000 --- a/cp/README.md +++ /dev/null @@ -1,3 +0,0 @@ -composer update - -Move env-sample to .env and configure. \ No newline at end of file