Compare commits
4 Commits
v0.1.0
...
c3771d22f2
| Author | SHA1 | Date | |
|---|---|---|---|
| c3771d22f2 | |||
| 6c49217e9c | |||
| 7758724eb5 | |||
| 484f00ddee |
84
README.md
84
README.md
@@ -25,9 +25,48 @@ It also **does not replace ServUO startup behavior.** ServUO keeps running throu
|
||||
its existing release/start scripts; the installer never writes a launcher and
|
||||
never restarts the shard.
|
||||
|
||||
## Install a shard with it
|
||||
|
||||
Grab a binary and `SHA256SUMS` from the
|
||||
[releases page](https://gitea.whitlocktech.com/RunicGateway/installer/releases),
|
||||
verify the checksum, and run it as Administrator/root against a **stopped** shard:
|
||||
|
||||
```bash
|
||||
sha256sum -c SHA256SUMS --ignore-missing
|
||||
chmod +x runicgateway-installer-linux-x86_64
|
||||
sudo ./runicgateway-installer-linux-x86_64 install
|
||||
```
|
||||
|
||||
```powershell
|
||||
# Windows, from an elevated PowerShell
|
||||
.\runicgateway-installer-windows-x86_64.exe install
|
||||
```
|
||||
|
||||
It ends by printing the four values to paste into **Admin → Shard** on your site.
|
||||
The full operator guide — what it asks, where it writes, the patch tier, day-two
|
||||
commands and troubleshooting — is
|
||||
[`installer/INSTALL.md`](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/installer/INSTALL.md).
|
||||
|
||||
Prefer to place everything yourself, or on a host that cannot run the binary?
|
||||
[INSTALL.md Appendix A](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/installer/INSTALL.md#appendix-a--installing-by-hand)
|
||||
is the same deployment done with `curl`, `tar` and `systemctl`, and stays
|
||||
supported.
|
||||
|
||||
## Status
|
||||
|
||||
**Phases 1 to 4 are built, on the `edge` branch. Nothing is released yet.**
|
||||
**Released.** All five phases are built and the `edge → main` cutover (#17) cut
|
||||
the first release, [`v0.1.0`](https://gitea.whitlocktech.com/RunicGateway/installer/releases),
|
||||
publishing `linux-x86_64`, `linux-aarch64` and `windows-x86_64.exe` with
|
||||
`SHA256SUMS`.
|
||||
|
||||
| Phase | State |
|
||||
|---|---|
|
||||
| 0 — prerequisites in the other repos | ✅ merged |
|
||||
| 1 — installer core: bundle resolution, ServUO detection, overlay sync, `install.json` | ✅ released |
|
||||
| 2 — uo-link install + service registration | ✅ released |
|
||||
| 3 — the opt-in stock-file patch tier | ✅ released |
|
||||
| 4 — `doctor`, `update`, `uninstall` | ✅ released |
|
||||
| 5 — packaging polish: Linux `aarch64`, backup before overwrite | ✅ released |
|
||||
|
||||
The binary does everything
|
||||
[`installer/INSTALL.md`](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/installer/INSTALL.md)
|
||||
@@ -40,39 +79,18 @@ The design of record is
|
||||
in the docs repo: phases, locked decisions, and the Phase 0 prerequisites in other
|
||||
repos (a `servuo-plugins` release workflow, a non-interactive config read-back in
|
||||
`link`, and the bundle-manifest CI here), all of which have landed —
|
||||
[`bundles/current.json`](bundles/current.json) names the current protocol-checked
|
||||
sidecar + overlay combination, recomposed on every component release and nightly
|
||||
(see [`bundles/README.md`](bundles/README.md)).
|
||||
[`bundles/current.json`](https://gitea.whitlocktech.com/RunicGateway/installer/src/branch/bundles/current.json)
|
||||
names the current protocol-checked sidecar + overlay combination, recomposed on
|
||||
every component release and nightly (see [`bundles/README.md`](bundles/README.md)).
|
||||
|
||||
| Phase | State |
|
||||
|---|---|
|
||||
| 0 — prerequisites in the other repos | ✅ merged |
|
||||
| 1 — installer core: bundle resolution, ServUO detection, overlay sync, `install.json` | ✅ on `edge` |
|
||||
| 2 — uo-link install + service registration | ✅ on `edge` |
|
||||
| 3 — the opt-in stock-file patch tier | ✅ on `edge` |
|
||||
| 4 — `doctor`, `update`, `uninstall` | ✅ on `edge` |
|
||||
| 5 — packaging polish: Linux `aarch64`, backup before overwrite | in progress |
|
||||
|
||||
**Why `edge`:** `release.yml` publishes an installer binary on every push to
|
||||
`main`, so nothing lands there until the whole tool is worth handing to an
|
||||
operator. The `edge → main` cutover cuts the first release. PRs into `edge` run
|
||||
the same gates as PRs into `main`.
|
||||
|
||||
**What the cutover is waiting on**, per PLAN.md §5:
|
||||
|
||||
1. **Phase 5**, packaging polish — deliberately *before* the first release rather
|
||||
than after it, because it changes the release layout, and shipping first would
|
||||
mean a first release immediately superseded by the next. There is no `.deb`
|
||||
and no MSI: both would give the sidecar binary, its service unit and its
|
||||
service account a second owner beside this tool.
|
||||
2. **The Windows SCM half verified on a real host.** `sc create`, the virtual
|
||||
service account, the failure actions and the token-file ACL have never been
|
||||
executed anywhere. Running the *systemd* half for real is what turned up a bug
|
||||
no unit test had, so this is not a formality.
|
||||
|
||||
Until the cutover, the way to install is by hand —
|
||||
[INSTALL.md Appendix A](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/installer/INSTALL.md#appendix-a--installing-by-hand)
|
||||
is the same deployment done with `curl`, `tar` and `systemctl`.
|
||||
**`main` publishes.** `release.yml` cuts a release from every push to `main`, which
|
||||
is why the crate was integrated on `edge` until it was worth handing to an
|
||||
operator. Both cutover gates were met first: Phase 5 (its scope settled as **no
|
||||
`.deb` and no MSI** — either would give the sidecar binary, its service unit and
|
||||
its service account a second owner beside this tool), and the **Windows SCM half
|
||||
verified on a real host**. That second one earned its place: `sc start` failed
|
||||
with 1053 on its first real run and needed a sidecar fix (link#29) before it
|
||||
passed 13/13.
|
||||
|
||||
## Related repos
|
||||
|
||||
|
||||
@@ -3,10 +3,27 @@
|
||||
//! ## Scoped by what cannot be fetched again
|
||||
//!
|
||||
//! Most of what this installer writes is replaceable: the sidecar binary and every overlay file are
|
||||
//! re-downloadable and hash-named in the bundle, and the sidecar's database is a cache with a schema
|
||||
//! — `link`'s `store.rs` creates every table `IF NOT EXISTS` and every one of them holds shard state
|
||||
//! the sweeps repopulate. Backing those up would be bulk with no recovery value, and the bulk is not
|
||||
//! free: it would bury the two things that matter.
|
||||
//! re-downloadable and hash-named in the bundle, and the sidecar's database is overwhelmingly a
|
||||
//! projection of shard state that the sweeps repopulate. Backing it up would be bulk with little
|
||||
//! recovery value, and the bulk is not free: it would bury the two things that matter.
|
||||
//!
|
||||
//! That reasoning used to be stated two ways that are no longer true, and the correction is worth
|
||||
//! keeping rather than quietly deleting:
|
||||
//!
|
||||
//! - It said the database is safe because `store.rs` creates every table `IF NOT EXISTS`. That held
|
||||
//! only while every schema change added a whole *table*. Protocol 4 adds a *column* to a table
|
||||
//! that already exists, which `IF NOT EXISTS` cannot do, so `link` now carries a real migration
|
||||
//! (`PRAGMA user_version` steps). A run can therefore change the database's structure, not just
|
||||
//! its contents.
|
||||
//! - It said every table holds state the sweeps repopulate. `events` does not: it is never pruned,
|
||||
//! and the website backfills the events it missed from `GET /history` on every reconnect. So a
|
||||
//! lost database costs the gap-recovery window for anything that happened while the site was down.
|
||||
//!
|
||||
//! The decision is unchanged — this still does not copy the database — because the argument against
|
||||
//! backing up unbounded bulk survives both corrections: `events` grows without limit, the migration
|
||||
//! is transactional and additive, and the website holds its own durable copy of everything it has
|
||||
//! already ingested. Only the *reason* was wrong. Whether that table should be pruned or protected
|
||||
//! is a question for `link`, on its own merits, not something to settle inside a backup policy.
|
||||
//!
|
||||
//! What a run can destroy irrecoverably is short:
|
||||
//!
|
||||
|
||||
Reference in New Issue
Block a user