From b1505b546d17d14e77a8ee68534793ae4e47e194 Mon Sep 17 00:00:00 2001
From: Marc Durdin <marc@durdin.net>
Date: Tue, 14 Oct 2025 11:25:38 +0200
Subject: [PATCH] docs: add Docker instructions to README.md

Part of a set of README.md updates for all our major websites.

Test-bot: skip
---
 README.md | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 105 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..a072c92b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,105 @@
+# s.keyman.com
+
+This is the source for the website https://s.keyman.com/, which contains static
+Javascript, font, and related resources for all the Keyman websites. This site
+runs on Apache in a Docker container.
+
+## 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 s.keyman.com locally
+
+When run locally, this site can be accessed at http://localhost:8054 or
+http://s.keyman.com.localhost:8054. Note that this site currently has
+no root index page.
+
+**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]
+
+  <details>
+  <summary>Configuration of Docker on Windows</summary>
+
+    On Windows machines, you can setup Docker in two different ways, either of
+    which should work:
+    * [Enable Hyper-V on Windows 11](https://techcommunity.microsoft.com/t5/educator-developer-blog/step-by-step-enabling-hyper-v-for-use-on-windows-11/ba-p/3745905)
+    * [WSL2](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-10#1-overview)
+
+  </details>
+
+### 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:
+
+```sh
+./build.sh build
+```
+
+#### Start the Docker container
+
+To start up the website, in bash, run:
+
+```sh
+./build.sh start --debug
+```
+
+Once the container starts, you can access the s.keyman.com site at
+http://localhost:8054 or http://s.keyman.com.localhost:8054. Note that this site
+currently has no root index page.
+
+#### Stop the Docker container
+
+In bash, run:
+
+```sh
+./build.sh stop
+```
+
+#### Remove the Docker container and image
+
+In bash, run:
+
+```sh
+./build.sh clean
+```
+
+#### Running tests
+
+To check for broken links and .php file conformance, when the site is running,
+in bash, run:
+
+```sh
+./build.sh test
+```
+
+[Git]: https://git-scm.com/downloads
+[Docker Desktop]: https://docs.docker.com/get-docker/
+[shared sites]: https://github.com/keymanapp/shared-sites
+[api.keyman.com]: https://github.com/keymanapp/api.keyman.com
+[help.keyman.com]: https://github.com/keymanapp/help.keyman.com
+[keyman.com]: https://github.com/keymanapp/keyman.com
+[keymanweb.com]: https://github.com/keymanapp/keymanweb.com
+[s.keyman.com]: https://github.com/keymanapp/s.keyman.com
+[website-local-proxy]: https://github.com/keymanapp/website-local-proxy
+[shared-sites]: https://github.com/keymanapp/shared-sites
+[enable Hyper-V]: https://techcommunity.microsoft.com/t5/educator-developer-blog/step-by-step-enabling-hyper-v-for-use-on-windows-11/ba-p/3745905
+[enable WSL2]: https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-10#1-overview