This is the source for the website https://keyman.com/, which is the home page for the Keyman project. This site runs on Apache in a Docker container.

• api.keyman.com - database backend for Keyman websites
• help.keyman.com - documentation home for Keyman
• keyman.com - Keyman home
• keymanweb.com - KeymanWeb online keyboard
• s.keyman.com - static Javascript, font, and related resources
• website-local-proxy - run all Keyman sites on localhost on the same port

When run locally, this site can be accessed at http://localhost:8053 or http://keyman.com.localhost:8053.

Recommended: Use website-local-proxy to run multiple keyman.com sites all from the same port (default port 80).

Recommended: Use shared-sites to control startup and shutdown of all keyman.com sites together.

The host machine needs the following apps installed:

• Git

• Bash 5.x (on Windows, you can use Git Bash that comes with Git)

• Docker Desktop

  Configuration of Docker on Windows

  On Windows machines, you can setup Docker in two different ways, either of which should work:

  • Enable Hyper-V on Windows 11
  • WSL2

The first time you want to start up the site, or if there have been Docker configuration changes, you will need to rebuild the Docker images. Start a bash shell, and from this folder, run:

./build.sh build

To start up the website, in bash, run:

./build.sh start --debug

Once the container starts, you can access the keyman.com site at http://localhost:8055 or http://keyman.com.localhost:8055

In bash, run:

./build.sh stop

In bash, run:

./build.sh clean

To check for broken links and .php file conformance, when the site is running, in bash, run:

./build.sh test