deploy: 38a2672

documentation/index.html

@@ -41,6 +41,10 @@
 </code></pre><p><br><a name=Control-xDebug></a></p><h2 id=start-stop-xdebug>Start/Stop xDebug:</h2><p>By installing xDebug, you are enabling it to run on startup by default.</p><p>To control the behavior of xDebug (in the <code>php-fpm</code> Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):</p><ul><li>Stop xDebug from running by default: <code>.php-fpm/xdebug stop</code>.</li><li>Start xDebug by default: <code>.php-fpm/xdebug start</code>.</li><li>See the status: <code>.php-fpm/xdebug status</code>.</li></ul><p>Note: If <code>.php-fpm/xdebug</code> doesn&rsquo;t execute and gives <code>Permission Denied</code> error the problem can be that file <code>xdebug</code> doesn&rsquo;t have execution access. This can be fixed by running <code>chmod</code> command with desired access permissions.</p><p><br><a name=Install-pcov></a></p><h2 id=install-pcov>Install pcov</h2><p>1 - First install <code>pcov</code> in the Workspace and the PHP-FPM Containers:<br>a) open the <code>.env</code> file<br>b) search for the <code>WORKSPACE_INSTALL_PCOV</code> argument under the Workspace Container<br>c) set it to <code>true</code><br>d) search for the <code>PHP_FPM_INSTALL_PCOV</code> argument under the PHP-FPM Container<br>e) set it to <code>true</code></p><p>2 - Re-build the containers <code>docker-compose build workspace php-fpm</code></p><p>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 <a href=https://github.com/krakjoe/pcov>README</a></p><p><br><a name=Install-phpdbg></a></p><h2 id=install-phpdbg>Install phpdbg</h2><p>Install <code>phpdbg</code> in the Workspace and the PHP-FPM Containers:</p><p><br>1 - Open the <code>.env</code>.</p><p>2 - Search for <code>WORKSPACE_INSTALL_PHPDBG</code>.</p><p>3 - Set value to <code>true</code></p><p>4 - Do the same for <code>PHP_FPM_INSTALL_PHPDBG</code></p><pre><code class=language-dotenv>WORKSPACE_INSTALL_PHPDBG=true
 </code></pre><pre><code class=language-dotenv>PHP_FPM_INSTALL_PHPDBG=true
+</code></pre><p><br><a name=Install-github-copilot-cli></a></p><h2 id=install-github-copilot-cli>Install Github Copilot Cli</h2><h3 id=note-you-must-have-github-copilot-access-to-use-this-feature>Note: You must have Github Copilot access to use this feature.</h3><p>Install <code>gh-cli</code> in the Workspace Container:</p><p><br>1 - Open the <code>.env</code>.</p><p>2 - Search for <code>WORKSPACE_INSTALL_GITHUB_CLI</code>.</p><p>3 - Set value to <code>true</code></p><pre><code class=language-dotenv>WORKSPACE_INSTALL_GITHUB_CLI=true
+</code></pre><p>4 - Re-build the containers <code>docker compose build workspace</code></p><p>5 - start your container <code>docker compose up -d workspace // ..and all your other containers</code></p><p>6 - Enter the Workspace container:</p><pre><code class=language-bash>docker-compose exec workspace bash
+</code></pre><p>7 - Authenticate with your github account and follow the instructions::</p><pre><code class=language-bash>gh auth login
+</code></pre><p>8 - Install the copilot cli:</p><pre><code class=language-bash> gh extension install github/gh-copilot
 </code></pre><p><br><a name=Install-ionCube-Loader></a></p><h2 id=install-ioncube-loader>Install ionCube Loader</h2><p>1 - First install <code>ionCube Loader</code> in the Workspace and the PHP-FPM Containers:<br>a) open the <code>.env</code> file<br>b) search for the <code>WORKSPACE_INSTALL_IONCUBE</code> argument under the Workspace Container<br>c) set it to <code>true</code><br>d) search for the <code>PHP_FPM_INSTALL_IONCUBE</code> argument under the PHP-FPM Container<br>e) set it to <code>true</code></p><p>2 - Re-build the containers <code>docker-compose build workspace php-fpm</code></p><p>Always download the latest version of <a href=http://www.ioncube.com/loaders.php>Loaders for ionCube </a>.</p><p><br><a name=Install-Deployer></a></p><h2 id=install-deployer>Install Deployer</h2><blockquote><p>A deployment tool for PHP.</p></blockquote><p>1 - Open the <code>.env</code> file<br>2 - Search for the <code>WORKSPACE_INSTALL_DEPLOYER</code> argument under the Workspace Container<br>3 - Set it to <code>true</code><br></p><p>4 - Re-build the containers <code>docker-compose build workspace</code></p><p><a href=https://deployer.org/docs/getting-started.html><strong>Deployer Documentation Here</strong></a></p><p><br><a name=Install-SonarQube></a></p><h2 id=install-sonarqube>Install SonarQube</h2><blockquote><p>An automatic code review tool.</p></blockquote><p>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.<br>1 - Open the <code>.env</code> file<br>2 - Search for the <code>SONARQUBE_HOSTNAME=sonar.example.com</code> argument<br>3 - Set it to your-domain <code>sonar.example.com</code><br>4 - <code>docker-compose up -d sonarqube</code><br>5 - Open your browser: <a href=http://localhost:9000/>http://localhost:9000/</a></p><p>Troubleshooting:</p><p>if you encounter a database error:</p><pre><code>docker-compose exec --user=root postgres
 source docker-entrypoint-initdb.d/init_sonarqube_db.sh
 </code></pre><p>If you encounter logs error:</p><pre><code>docker-compose run --user=root --rm sonarqube chown sonarqube:sonarqube /opt/sonarqube/logs

index.html

@@ -176,6 +176,10 @@
 </code></pre><p><br><a name=Control-xDebug></a></p><h2 id=start-stop-xdebug>Start/Stop xDebug:</h2><p>By installing xDebug, you are enabling it to run on startup by default.</p><p>To control the behavior of xDebug (in the <code>php-fpm</code> Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):</p><ul><li>Stop xDebug from running by default: <code>.php-fpm/xdebug stop</code>.</li><li>Start xDebug by default: <code>.php-fpm/xdebug start</code>.</li><li>See the status: <code>.php-fpm/xdebug status</code>.</li></ul><p>Note: If <code>.php-fpm/xdebug</code> doesn&rsquo;t execute and gives <code>Permission Denied</code> error the problem can be that file <code>xdebug</code> doesn&rsquo;t have execution access. This can be fixed by running <code>chmod</code> command with desired access permissions.</p><p><br><a name=Install-pcov></a></p><h2 id=install-pcov>Install pcov</h2><p>1 - First install <code>pcov</code> in the Workspace and the PHP-FPM Containers:<br>a) open the <code>.env</code> file<br>b) search for the <code>WORKSPACE_INSTALL_PCOV</code> argument under the Workspace Container<br>c) set it to <code>true</code><br>d) search for the <code>PHP_FPM_INSTALL_PCOV</code> argument under the PHP-FPM Container<br>e) set it to <code>true</code></p><p>2 - Re-build the containers <code>docker-compose build workspace php-fpm</code></p><p>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 <a href=https://github.com/krakjoe/pcov>README</a></p><p><br><a name=Install-phpdbg></a></p><h2 id=install-phpdbg>Install phpdbg</h2><p>Install <code>phpdbg</code> in the Workspace and the PHP-FPM Containers:</p><p><br>1 - Open the <code>.env</code>.</p><p>2 - Search for <code>WORKSPACE_INSTALL_PHPDBG</code>.</p><p>3 - Set value to <code>true</code></p><p>4 - Do the same for <code>PHP_FPM_INSTALL_PHPDBG</code></p><pre><code class=language-dotenv>WORKSPACE_INSTALL_PHPDBG=true
 </code></pre><pre><code class=language-dotenv>PHP_FPM_INSTALL_PHPDBG=true
+</code></pre><p><br><a name=Install-github-copilot-cli></a></p><h2 id=install-github-copilot-cli>Install Github Copilot Cli</h2><h3 id=note-you-must-have-github-copilot-access-to-use-this-feature>Note: You must have Github Copilot access to use this feature.</h3><p>Install <code>gh-cli</code> in the Workspace Container:</p><p><br>1 - Open the <code>.env</code>.</p><p>2 - Search for <code>WORKSPACE_INSTALL_GITHUB_CLI</code>.</p><p>3 - Set value to <code>true</code></p><pre><code class=language-dotenv>WORKSPACE_INSTALL_GITHUB_CLI=true
+</code></pre><p>4 - Re-build the containers <code>docker compose build workspace</code></p><p>5 - start your container <code>docker compose up -d workspace // ..and all your other containers</code></p><p>6 - Enter the Workspace container:</p><pre><code class=language-bash>docker-compose exec workspace bash
+</code></pre><p>7 - Authenticate with your github account and follow the instructions::</p><pre><code class=language-bash>gh auth login
+</code></pre><p>8 - Install the copilot cli:</p><pre><code class=language-bash> gh extension install github/gh-copilot
 </code></pre><p><br><a name=Install-ionCube-Loader></a></p><h2 id=install-ioncube-loader>Install ionCube Loader</h2><p>1 - First install <code>ionCube Loader</code> in the Workspace and the PHP-FPM Containers:<br>a) open the <code>.env</code> file<br>b) search for the <code>WORKSPACE_INSTALL_IONCUBE</code> argument under the Workspace Container<br>c) set it to <code>true</code><br>d) search for the <code>PHP_FPM_INSTALL_IONCUBE</code> argument under the PHP-FPM Container<br>e) set it to <code>true</code></p><p>2 - Re-build the containers <code>docker-compose build workspace php-fpm</code></p><p>Always download the latest version of <a href=http://www.ioncube.com/loaders.php>Loaders for ionCube </a>.</p><p><br><a name=Install-Deployer></a></p><h2 id=install-deployer>Install Deployer</h2><blockquote><p>A deployment tool for PHP.</p></blockquote><p>1 - Open the <code>.env</code> file<br>2 - Search for the <code>WORKSPACE_INSTALL_DEPLOYER</code> argument under the Workspace Container<br>3 - Set it to <code>true</code><br></p><p>4 - Re-build the containers <code>docker-compose build workspace</code></p><p><a href=https://deployer.org/docs/getting-started.html><strong>Deployer Documentation Here</strong></a></p><p><br><a name=Install-SonarQube></a></p><h2 id=install-sonarqube>Install SonarQube</h2><blockquote><p>An automatic code review tool.</p></blockquote><p>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.<br>1 - Open the <code>.env</code> file<br>2 - Search for the <code>SONARQUBE_HOSTNAME=sonar.example.com</code> argument<br>3 - Set it to your-domain <code>sonar.example.com</code><br>4 - <code>docker-compose up -d sonarqube</code><br>5 - Open your browser: <a href=http://localhost:9000/>http://localhost:9000/</a></p><p>Troubleshooting:</p><p>if you encounter a database error:</p><pre><code>docker-compose exec --user=root postgres
 source docker-entrypoint-initdb.d/init_sonarqube_db.sh
 </code></pre><p>If you encounter logs error:</p><pre><code>docker-compose run --user=root --rm sonarqube chown sonarqube:sonarqube /opt/sonarqube/logs