help.keyman.com

This is the source for the website https://help.keyman.com/. This site runs on Apache in a Docker container.

Documentation sources

Many of the pages on this site are deployed from other repositories and should be edited in the source repository rather than here:

• From https://github.com/keymanapp/keyboards (deployed when PRs are merged):
  • /keyboard/
• From https://github.com/keymanapp/keyman (see resources/build/help-keyman-com.sh):
  • /products/android/
  • /products/iphone-and-ipad/
  • /products/linux/
  • /products/mac/
  • /products/windows/
  • /developer/(.)/ (versioned folders)
  • /developer/engine/android/
  • /developer/engine/iphone-and-ipad/
  • /developer/engine/web/
  • /developer/engine/windows/
  • /developer/core/

Other Keyman websites

• 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

How to run help.keyman.com locally

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

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.

Prerequisites

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

Actions

Build the Docker image

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

If you'll be running tests locally, the Docker image will need to be built with dev dependencies:

./build.sh build --debug

Start the Docker container

To start up the website, in bash, run:

./build.sh start --debug

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

Stop the Docker container

In bash, run:

./build.sh stop

Remove the Docker container and image

In bash, run:

./build.sh clean

Running tests

When the site is running, the test action will do the following:

• PHP unit tests
• Check .php file conformance
• Check for internal broken links

in bash, run:

./build.sh test