From 03534c8db14752e03aa1d3a8f797a7325a1dbb41 Mon Sep 17 00:00:00 2001 From: wtclaude Date: Fri, 7 Aug 2026 16:05:57 -0500 Subject: [PATCH] docs(readme): say how to get a sidecar before explaining how it is used The shard integration section documented the contract in detail but never told an admin where the base URL, WS URL, protocol version and token come from. They come from the installer, which prints them at the end of a run. Co-Authored-By: Claude --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index be7343b..f96a7d4 100644 --- a/README.md +++ b/README.md @@ -416,6 +416,29 @@ exposes a small, authenticated HTTP + WebSocket API; this website is a *client* itself is never exposed to the internet ā€” only the sidecar is, and only the website's backend talks to it. +### Setting up the shard side + +You do not build or place any of it by hand. The +**[Runic Gateway installer](https://gitea.whitlocktech.com/RunicGateway/installer)** runs on the +shard host, deploys the ServUO plugin and the uo-link sidecar as a matched, protocol-checked pair, +registers the sidecar as a service, and ends by printing the four values this site needs: + +``` +Base URL http://:8080 +WebSocket URL ws://:8080/ws +Protocol version 3 +Auth token 4f9cā€¦ +``` + +Paste them into **Admin ā†’ Shard** here and the bridge is live. The operator guide is +[installer/INSTALL.md](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/installer/INSTALL.md); +its [Appendix A](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/installer/INSTALL.md#appendix-a--installing-by-hand) +is the same deployment done by hand, still supported, for a host that cannot run the binary or a +developer working from a source tree. + +Nothing here needs the shard to exist: with no sidecar configured the site renders normally and +shows the shard offline. + ### How it works ``` -- 2.49.1