-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for working SSL certificate using mkcert
- Loading branch information
1 parent
a5bdc3c
commit d3e7b1a
Showing
5 changed files
with
21 additions
and
9 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 |
---|---|---|
|
@@ -24,3 +24,6 @@ | |
.Trashes | ||
ehthumbs.db | ||
Thumbs.db | ||
|
||
# Ignore Jetbrains IDE files | ||
.idea/ |
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
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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
* | ||
!.gitignore |
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
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 |
---|---|---|
|
@@ -32,7 +32,7 @@ Site setup, development environment and deploy tooling for [WordPress VIP](https | |
|
||
We suggest using [Homebrew](https://brew.sh) on macOS or [Chocolatey](https://chocolatey.org) for Windows to install the project dependencies. | ||
|
||
brew install git [email protected] composer node@18 mkcert | ||
brew install git [email protected] composer node@18 mkcert nss | ||
brew install --cask docker | ||
|
||
|
||
|
@@ -99,7 +99,7 @@ Consider using a dedicated GitHub [machine user](https://docs.github.com/en/get- | |
|
||
1. Clone this repository: | ||
|
||
git clone [email protected]:wpcomvip/devgo-vip.git | ||
git clone [email protected]:xwp/vip-site-template.git devgo-vip | ||
|
||
2. Move into the project directory: | ||
|
||
|
@@ -109,21 +109,25 @@ Consider using a dedicated GitHub [machine user](https://docs.github.com/en/get- | |
|
||
npm install | ||
|
||
4. Start the development environment using Docker: | ||
4. Install ssl certificate to add the certificate authority of the development environment [`local/data/mkcert/rootCA.pem`](local/data/mkcert/rootCA.pem) to the trusted list on your computer. Alternatively, [configure it manually](https://support.apple.com/guide/keychain-access/add-certificates-to-a-keychain-kyca2431/mac). | ||
|
||
npm run install-cert | ||
|
||
5Start the development environment using Docker: | ||
|
||
npm run start | ||
|
||
and `npm run stop` to stop the virtual environment at any time. Run `npm run start-debug` to start the environment in debug mode where all output from containers is displayed. Run `npm run stop-all` to stop all active Docker containers in case you're running into port conflicts. | ||
|
||
5. Install the local WordPress multisite environment: | ||
6Install the local WordPress multisite environment: | ||
|
||
npm run setup | ||
|
||
with the configuration from `local/public/wp-cli.yml`. | ||
|
||
6. Visit [local.wpenv.net](https://local.wpenv.net) to view the development environment. WordPress username `devgo` and password `devgo`. | ||
7Visit [local.wpenv.net](https://local.wpenv.net) to view the development environment. WordPress username `devgo` and password `devgo`. | ||
|
||
7. Visit [mail.local.wpenv.net](https://mail.local.wpenv.net) to view all emails sent by WordPress. | ||
8Visit [mail.local.wpenv.net](https://mail.local.wpenv.net) to view all emails sent by WordPress. | ||
|
||
The local development environment uses a self-signed SSL sertificate for HTTPS so the "Your connection is not private" error can be ignored to visit the site. | ||
|
||
|
@@ -199,6 +203,8 @@ We use `npm` as the canonical task runner for things like linting files and crea | |
|
||
- `npm run vip` to run [VIP CLI](https://wpvip.com/documentation/vip-go/vip-cli/) commands on staging and production environments. | ||
|
||
- `npm run install-cert` to mark the self-signed SSL certificate authority (under [`local/certs/rootCA.pem`](local/certs/rootCA.pem)) for the local development environment as trusted. Make sure [`mkcert` is installed on your computer](#install-dependencies). This command is required to avoid the "Your connection is not private" error when visiting the site. Stop the local environment before running this command and restart the browser/tab after installing the certificate and starting the environment again. | ||
|
||
|
||
## Deployments 🚀 | ||
|
||
|