docs(installer): lead with the installer now that it is released
v0.1.0 shipped on 2026-08-07, so every doc that said "not released yet" was wrong the moment the cutover merged. - INSTALL.md: replace the pre-release status banner. The installer is the path the guide leads with; Appendix A is reframed as supported-not- deprecated, for hosts that cannot run the binary, operators who want to place files themselves, and development from a working tree. - PLAN.md: status is Shipped, both cutover gates recorded as met (incl. the Windows 1053 handshake bug the real SCM run found), Phase 5 table and 5.4 closed out. - README.md: point anyone setting up a shard at INSTALL.md first. - link/link-README.md: mark the pre-split snapshot as historical, so its deploy.ps1 instructions stop reading as the setup path. Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -3,25 +3,15 @@
|
||||
Operator guide for the **Runic Gateway installer** — the tool that takes a working ServUO
|
||||
installation and connects it to a Runic Gateway website.
|
||||
|
||||
> **Status: the installer binary is not released yet.**
|
||||
> **The installer is the supported way to set this up.** Download one binary, run `install`, paste
|
||||
> four values into your website. It deploys the plugin overlay, installs the uo-link sidecar and
|
||||
> registers it as a service, and gives you [`doctor`, `update` and `uninstall`](#7-day-two)
|
||||
> afterwards. Start at [§1](#1-download-and-verify).
|
||||
>
|
||||
> Phases 1 to 3 are built and live on the installer repo's `edge` branch: the installer core
|
||||
> (bundle resolution, ServUO detection, the overlay sync, `install.json`), the sidecar half (the
|
||||
> binary, its config, its service, and the token handoff), and the
|
||||
> [patch tier](#4-the-patch-tier-optional). `install` is therefore complete; what is still missing
|
||||
> is [`doctor`, `update` and `uninstall`](#7-day-two), each of which reports which phase it arrives
|
||||
> in rather than failing as though you had mistyped it. The first release is being cut from that
|
||||
> branch now.
|
||||
>
|
||||
> Everything it installs *is* released and published — the sidecar, the plugin overlay, and the
|
||||
> [bundle manifest](https://gitea.whitlocktech.com/RunicGateway/installer/src/branch/main/bundles/current.json)
|
||||
> that names the checked combination of the two. This guide is the operator-facing contract those
|
||||
> phases build to, and it is written first on purpose: it is the specification of what the run
|
||||
> looks like, what it asks, where it writes, and what it prints.
|
||||
>
|
||||
> **You can install today without it** — [Appendix A](#appendix-a--installing-by-hand) is the same
|
||||
> deployment done by hand, with the commands verified against the current releases. When the binary
|
||||
> ships, Appendix A stays as the reference for what it does under the hood.
|
||||
> [Appendix A](#appendix-a--installing-by-hand) is the same deployment done by hand. It is
|
||||
> **supported, not deprecated** — use it on a host that cannot run the binary, when you want to
|
||||
> place things yourself, or when you are developing on the bridge and installing from a working
|
||||
> tree rather than a release. It is also the reference for what the installer does under the hood.
|
||||
>
|
||||
> Design of record: [PLAN.md](PLAN.md).
|
||||
|
||||
@@ -642,8 +632,13 @@ release tarball is gone, and the report tells you to diff against them.
|
||||
|
||||
## Appendix A — installing by hand
|
||||
|
||||
This is what the installer automates. It works today, on the current releases, and is the fallback
|
||||
whenever you would rather not run an unsigned binary.
|
||||
This is what the installer automates, done by hand. It is a **supported path**, not a deprecated
|
||||
one — reach for it when the host cannot run the binary, when you would rather not run an unsigned
|
||||
one, when you want to place every file yourself, or when you are developing on the bridge and
|
||||
installing from a working tree instead of a release. It is also the reference for what
|
||||
[§2](#2-run-it) does under the hood.
|
||||
|
||||
For a normal shard, [the installer](#1-download-and-verify) is fewer steps and checks more.
|
||||
|
||||
Throughout: `<servuo>` is your ServUO root, and **the shard is stopped**.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user