-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5ce30c8
commit c81fab7
Showing
9 changed files
with
251 additions
and
230 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| <p align="center"> | ||
| <img alt="devENV" src="./env-core/images/featured.png" height="100%" width="40%"> | ||
| <img alt="devENV" src="./env-core/docs/images/featured.png" height="100%" width="40%"> | ||
| </p> | ||
|
|
||
| # Local Docker Wordpress CLI Development Environment | ||
|
|
@@ -81,238 +81,11 @@ Spin up a local environment on Linux, Mac, and Windows using CLI. | |
|
|
||
| <br> | ||
|
|
||
| # 5. Start the application: | ||
|
|
||
| Run from the command line: | ||
|
|
||
| ``` | ||
| ./setup.sh | ||
| ``` | ||
|
|
||
| ## 5.1 First setup | ||
|
|
||
| First of all you need to run Nginx server [option 1] | ||
|
|
||
| | Step | Option | Description | | ||
| |------|--------|--------------------------| | ||
| | 1 | 1 | Nginx | | ||
| | 2 | 1 | Setup Nginx server | | ||
| | 3 | 0 | Return to main menu | | ||
|
|
||
| <br> | ||
|
|
||
| ## 5.2 Create new project [default] | ||
|
|
||
| | Step | Option | Description | Example | | | ||
| |------|---------|---------------------------|----------------|---| | ||
| | 1 | 2 | New project | | | | ||
| | 2 | 1 | default | | | | ||
| | 3 | | Enter Domain Name | test | | | ||
| | 4 | | Enter DOMAIN_FULL | dev.test.local | * | | ||
| | 5 | [Y/n] | Is correct? | | | | ||
| | 6 | [Y/n] | Remove default content? | | | | ||
| | 7 | [Y/n] | Clone project? | | | | ||
| | 8 | | Windows: Add to host file | | | | ||
|
|
||
| *Variables has default value. | ||
|
|
||
| <br> | ||
|
|
||
| ## 5.3 Create new project [custom] | ||
|
|
||
| | Step | Option | Description | Example | | | ||
| |------|---------|---------------------------|----------------|---| | ||
| | 1 | 2 | New project | | | | ||
| | 2 | 2 | custom | | | | ||
| | 3 | | Enter Domain Name | test | | | ||
| | 4 | | Enter DOMAIN_FULL | dev.test.local | * | | ||
| | 5 | | Enter DB_NAME | db | * | | ||
| | 6 | | Enter TABLE_PREFIX | wp_ | * | | ||
| | 7 | | Enter WP_VERSION | 5.8.3 | * | | ||
| | 8 | | Enter WP_USER | developer | * | | ||
| | 9 | | Enter WP_PASSWORD | 1 | * | | ||
| | 10 | | Enter PHP_VERSION | 8.0 | * | | ||
| | 11 | [Y/n] | Install Composer ? | no | * | | ||
| | 12 | [Y/n] | Is correct? | | | | ||
| | 13 | [Y/n] | Remove default content? | | | | ||
| | 14 | [Y/n] | Clone project? | | | | ||
| | 15 | | Windows: Add to host file | | | | ||
|
|
||
| *Variables has default value. | ||
| # [5. Start the application](./env-core/docs/5-doc.MD#5-start-the-application) | ||
|
|
||
| <br> | ||
|
|
||
| ## 5.4 Create new project [beetroot] | ||
|
|
||
| | Step | Option | Description | Example | | | ||
| |------|---------|---------------------------|----------------|---| | ||
| | 1 | 2 | New project | | | | ||
| | 2 | 3 | beetroot | | | | ||
| | 3 | | Enter Domain Name | test | | | ||
| | 4 | 1 | type? [default] [custom] | | | | ||
| | 5 | | Enter DOMAIN_FULL | dev.test.local | * | | ||
| | 6 | [Y/n] | Is correct? | | | | ||
| | 7 | [Y/n] | Remove default content? | | | | ||
| | 8 | [Y/n] | Clone project? | | | | ||
| | 9 | | Repo url | | | | ||
| | 10 | | Windows: Add to host file | | | | ||
|
|
||
| *Variables has default value. | ||
|
|
||
| <br> | ||
|
|
||
| ## 5.5 Environment options: | ||
|
|
||
| ``` | ||
| 1 - Nginx | ||
| 1 - Setup Nginx container first time | ||
| 2 - Stop container | ||
| 3 - Start container | ||
| 4 - Restart container | ||
| 5 - Rebuild Nginx container | ||
| 2 - New project | ||
| 1 - default | ||
| 2 - custom | ||
| 3 - beetroot | ||
| 3 - Existing project | ||
| 1 - Docker actions | ||
| 1 - Permanently remove project | ||
| 2 - Stop container | ||
| 3 - Start container | ||
| 4 - Restart container | ||
| 5 - Rebuild container | ||
| 6 - Fix permissions | ||
| 7 - Run composer.json | ||
| 8 - Install composer package | ||
| 2 - Database actions | ||
| 1 - Update DB (import from backup file) | ||
| 2 - Dump DB (export to backup file) | ||
| 3 - Search-Replace | ||
| 4 - Replace project from DB | ||
| 3 - GIT actions | ||
| 1 - Clone from repo | ||
| 2 - Create GitHUB repo | ||
| 3 - Create GitLAB repo | ||
| 4 - List of exisiting projects | ||
| 4 - ENV settings | ||
| 1 - ENV_UPDATES | ||
| 2 - ENV_THEME | ||
| ``` | ||
|
|
||
| <br> | ||
|
|
||
| # 6. How to: | ||
|
|
||
| ## 6.1 Install trusted certificates | ||
|
|
||
|
|
||
| ``` | ||
| Certificates will be automatically created for all running instances. | ||
| You need one time manually add root certs: | ||
| ``` | ||
|
|
||
|
|
||
| | Step | Action | Description | | ||
| |------|-----------------------|-------------------------------------------| | ||
| | 1 | Open directory | env-core/nginx/certs-root/ | | ||
| | 2 | Rename file | rootCA.pem => rootCA.crt | | ||
| | 3 | Open certificate | rootCA.crt | | ||
| | 4 | Install certificate | [screen 1](./env-core/images/certs-1.jpg) | | ||
| | 5 | Choose store location | [screen 2](./env-core/images/certs-2.jpg) | | ||
| | 6 | Select store | [screen 3](./env-core/images/certs-3.jpg) | | ||
| | 7 | Import certificate | [screen 4](./env-core/images/certs-4.jpg) | | ||
| | 8 | Confirm install | [screen 5](./env-core/images/certs-5.jpg) | | ||
| | 9 | Restart browser | | | ||
|
|
||
|
|
||
| Tutorials how to setup: | ||
|
|
||
| 1. [Windows:](https://docs.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate) Installing a trusted root certificate | ||
| 2. [Mac:](https://support.securly.com/hc/en-us/articles/206058318-How-to-install-the-Securly-SSL-certificate-on-Mac-OSX-) How to install the Securly SSL certificate on Mac OSX | ||
|
|
||
| ### Don't forget to restart your browser ! | ||
|
|
||
| If you reinstall the environment, you need to update the root certificates. | ||
|
|
||
|
|
||
| <br> | ||
|
|
||
| ## 6.2 Add or remove a vhost | ||
|
|
||
| ``` | ||
| For Windows User | ||
| Please remember to add or remove your domain in the Windows host file: | ||
| 1. Open file to edit [C:\Windows\System32\drivers\etc\hosts] | ||
| 2. Add line as an example: 127.0.0.1 dev.test.local | ||
| 3. Save file | ||
| ``` | ||
|
|
||
| <br> | ||
|
|
||
| ## 6.3 Database management tool | ||
|
|
||
| ``` | ||
| In this envinronment used Adminer database management tool. | ||
| To access any database, all you need to do is visit its link through your browser. | ||
| As an example: https://dev.test.local/adminer.php | ||
| ``` | ||
|
|
||
| Tutorials: | ||
|
|
||
| 1. [How to use Adminer](https://kinsta.com/blog/adminer/) | ||
|
|
||
|
|
||
| <br> | ||
|
|
||
| ## 6.4 GIT | ||
| ``` | ||
| An access token is used to automatically create repositories for project using the command line. | ||
| ``` | ||
| Tutorials: | ||
|
|
||
| 1. [GitHub: Creating a personal access token](https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) | ||
| 2. [GitLab: Creating a personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) | ||
| # [6. How to](./env-core/docs/6-doc.MD#6-how-to) | ||
|
|
||
| <br> | ||
|
|
||
|
|
||
Oops, something went wrong.