From a876c27ee22b514d4da4f8d80b54fda7ca4f5d35 Mon Sep 17 00:00:00 2001 From: Darcy Wong Date: Tue, 16 Jan 2024 11:17:50 +0700 Subject: [PATCH] docs(common): Update README.md * update configure step about downloading _common/ files * Add info about website-local-proxy --- docs/websites/README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/websites/README.md b/docs/websites/README.md index 33c2883500..4696b63fc9 100644 --- a/docs/websites/README.md +++ b/docs/websites/README.md @@ -35,20 +35,21 @@ Docker tends to throttle Docker image downloads, so some developer offices may w This stops the Docker container for the site. #### Build the Docker image -1. Run `./build.sh build`. +1. Run `./build.sh build` This downloads and builds the Docker images needed for the site. #### Configure 1. Run `./build.sh configure`. -This step is currently not needed +This step typically downloads _common/ website files from [shared-sites](https://github.com/keymanapp/shared-sites/tree/main/_common). #### Start the Docker container 1. Run `./build.sh start`. This maps the local directory to the the Docker image. -Then, it creates a link of the PHP dependencies in Docker image from /var/www/vendor/ to /var/www/html/vendor. + +For sites that use Composer dependencies, this step also creates a link in the Docker image from /var/www/vendor/ to /var/www/html/vendor. The link file also appears locally. After this, you can access the website at the following ports: @@ -65,11 +66,19 @@ After this, you can access the website at the following ports: Checks for broken links 1. Run `./build.sh test` +#### Using Website-Local-Proxy +Rather than remembering localhost port values, you can clone and run [website-local-proxy](https://github.com/keymanapp/website-local-proxy). + +Follow https://github.com/keymanapp/website-local-proxy?tab=readme-ov-file#using-website-local-proxy and you can access the local websites at +http://*keyman.com.localhost + + --------- ## Kubernetes Deployment For production, the websites are deployed with Kubernetes. +Note: the following section is outdated as it's replaced with Rancher/Fleet. ### How to run help.keyman.com locally with Docker Desktop's Kubernetes singlenode cluster