diff --git a/documentation/index.html b/documentation/index.html index 8aa4226404..808c4679ac 100644 --- a/documentation/index.html +++ b/documentation/index.html @@ -41,6 +41,10 @@


Start/Stop xDebug:

By installing xDebug, you are enabling it to run on startup by default.

To control the behavior of xDebug (in the php-fpm Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):

Note: If .php-fpm/xdebug doesn’t execute and gives Permission Denied error the problem can be that file xdebug doesn’t have execution access. This can be fixed by running chmod command with desired access permissions.


Install pcov

1 - First install pcov in the Workspace and the PHP-FPM Containers:
a) open the .env file
b) search for the WORKSPACE_INSTALL_PCOV argument under the Workspace Container
c) set it to true
d) search for the PHP_FPM_INSTALL_PCOV argument under the PHP-FPM Container
e) set it to true

2 - Re-build the containers docker-compose build workspace php-fpm

Note that pcov is only supported on PHP 7.1 or newer. For more information on setting up pcov optimally, check the recommended section of the README


Install phpdbg

Install phpdbg in the Workspace and the PHP-FPM Containers:


1 - Open the .env.

2 - Search for WORKSPACE_INSTALL_PHPDBG.

3 - Set value to true

4 - Do the same for PHP_FPM_INSTALL_PHPDBG

WORKSPACE_INSTALL_PHPDBG=true
 
PHP_FPM_INSTALL_PHPDBG=true
+


Install Github Copilot Cli

Note: You must have Github Copilot access to use this feature.

Install gh-cli in the Workspace Container:


1 - Open the .env.

2 - Search for WORKSPACE_INSTALL_GITHUB_CLI.

3 - Set value to true

WORKSPACE_INSTALL_GITHUB_CLI=true
+

4 - Re-build the containers docker compose build workspace

5 - start your container docker compose up -d workspace // ..and all your other containers

6 - Enter the Workspace container:

docker-compose exec workspace bash
+

7 - Authenticate with your github account and follow the instructions::

gh auth login
+

8 - Install the copilot cli:

 gh extension install github/gh-copilot
 


Install ionCube Loader

1 - First install ionCube Loader in the Workspace and the PHP-FPM Containers:
a) open the .env file
b) search for the WORKSPACE_INSTALL_IONCUBE argument under the Workspace Container
c) set it to true
d) search for the PHP_FPM_INSTALL_IONCUBE argument under the PHP-FPM Container
e) set it to true

2 - Re-build the containers docker-compose build workspace php-fpm

Always download the latest version of Loaders for ionCube .


Install Deployer

A deployment tool for PHP.

1 - Open the .env file
2 - Search for the WORKSPACE_INSTALL_DEPLOYER argument under the Workspace Container
3 - Set it to true

4 - Re-build the containers docker-compose build workspace

Deployer Documentation Here


Install SonarQube

An automatic code review tool.

SonarQube® is an automatic code review tool to detect bugs, vulnerabilities and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.
1 - Open the .env file
2 - Search for the SONARQUBE_HOSTNAME=sonar.example.com argument
3 - Set it to your-domain sonar.example.com
4 - docker-compose up -d sonarqube
5 - Open your browser: http://localhost:9000/

Troubleshooting:

if you encounter a database error:

docker-compose exec --user=root postgres
 source docker-entrypoint-initdb.d/init_sonarqube_db.sh
 

If you encounter logs error:

docker-compose run --user=root --rm sonarqube chown sonarqube:sonarqube /opt/sonarqube/logs
diff --git a/index.html b/index.html
index 435c22d097..e0aa13b6d4 100644
--- a/index.html
+++ b/index.html
@@ -176,6 +176,10 @@
 


Start/Stop xDebug:

By installing xDebug, you are enabling it to run on startup by default.

To control the behavior of xDebug (in the php-fpm Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):

Note: If .php-fpm/xdebug doesn’t execute and gives Permission Denied error the problem can be that file xdebug doesn’t have execution access. This can be fixed by running chmod command with desired access permissions.


Install pcov

1 - First install pcov in the Workspace and the PHP-FPM Containers:
a) open the .env file
b) search for the WORKSPACE_INSTALL_PCOV argument under the Workspace Container
c) set it to true
d) search for the PHP_FPM_INSTALL_PCOV argument under the PHP-FPM Container
e) set it to true

2 - Re-build the containers docker-compose build workspace php-fpm

Note that pcov is only supported on PHP 7.1 or newer. For more information on setting up pcov optimally, check the recommended section of the README


Install phpdbg

Install phpdbg in the Workspace and the PHP-FPM Containers:


1 - Open the .env.

2 - Search for WORKSPACE_INSTALL_PHPDBG.

3 - Set value to true

4 - Do the same for PHP_FPM_INSTALL_PHPDBG

WORKSPACE_INSTALL_PHPDBG=true
 
PHP_FPM_INSTALL_PHPDBG=true
+


Install Github Copilot Cli

Note: You must have Github Copilot access to use this feature.

Install gh-cli in the Workspace Container:


1 - Open the .env.

2 - Search for WORKSPACE_INSTALL_GITHUB_CLI.

3 - Set value to true

WORKSPACE_INSTALL_GITHUB_CLI=true
+

4 - Re-build the containers docker compose build workspace

5 - start your container docker compose up -d workspace // ..and all your other containers

6 - Enter the Workspace container:

docker-compose exec workspace bash
+

7 - Authenticate with your github account and follow the instructions::

gh auth login
+

8 - Install the copilot cli:

 gh extension install github/gh-copilot
 


Install ionCube Loader

1 - First install ionCube Loader in the Workspace and the PHP-FPM Containers:
a) open the .env file
b) search for the WORKSPACE_INSTALL_IONCUBE argument under the Workspace Container
c) set it to true
d) search for the PHP_FPM_INSTALL_IONCUBE argument under the PHP-FPM Container
e) set it to true

2 - Re-build the containers docker-compose build workspace php-fpm

Always download the latest version of Loaders for ionCube .


Install Deployer

A deployment tool for PHP.

1 - Open the .env file
2 - Search for the WORKSPACE_INSTALL_DEPLOYER argument under the Workspace Container
3 - Set it to true

4 - Re-build the containers docker-compose build workspace

Deployer Documentation Here


Install SonarQube

An automatic code review tool.

SonarQube® is an automatic code review tool to detect bugs, vulnerabilities and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.
1 - Open the .env file
2 - Search for the SONARQUBE_HOSTNAME=sonar.example.com argument
3 - Set it to your-domain sonar.example.com
4 - docker-compose up -d sonarqube
5 - Open your browser: http://localhost:9000/

Troubleshooting:

if you encounter a database error:

docker-compose exec --user=root postgres
 source docker-entrypoint-initdb.d/init_sonarqube_db.sh
 

If you encounter logs error:

docker-compose run --user=root --rm sonarqube chown sonarqube:sonarqube /opt/sonarqube/logs