Public Access
Let the desktop client replace itself, and give the repository one version
Packaging for Windows, and the updater that only exists once something is
packaged. Velopack, win-x64, fed from the project's own forge — never from the
deployment a client signs in to, which is ADR 0011 rule 2 carried over
unchanged and is why the feed address is a constant in the code rather than a
setting. See docs/adr/0012-desktop-distribution-and-updates.md.
**Nothing is ever installed while somebody is using it.** A newer build is found
on a six-hourly pass, downloaded in the background, and then waits — for a
restart the user presses, or for the next launch they were going to do anyway.
That is a policy rather than caution: this application argues at length that
locking keeps shells running, because a lock that destroyed work would stop
being used, and a restart does not keep them. Having taught that, it owes the
user the choice at the one moment it stops being true, and the sentence saying
so counts the shells it would close.
**The version is now derived from the v* tag**, by MinVer, for everything. There
was no version before this — no property anywhere, so every assembly reported
the SDK's 1.0.0 and the API served that string as its serverVersion to every
client that asked. The tag was already the version of record for the container
image; this makes it the version of record full stop. MinVer's failure mode is
answering plausibly rather than failing, and here a wrong version is a client
that never updates, so it is guarded twice: fetch-depth 0 on every checkout, and
a step that fails a tag build when the tag and the computed version disagree.
**The pack id is DodoSSH.Desktop and not DodoSSH**, which is the one decision
here that would have destroyed data. Velopack installs to %LOCALAPPDATA%\<packId>
and removes that whole directory on uninstall, and %LOCALAPPDATA%\DodoSSH is
where ClientPaths keeps the encrypted cache, the outbox of changes not yet
pushed, and the device key. The obvious id would have had the uninstaller
silently delete work the server has never seen — the thing the application
refuses to do without a counted confirmation. Velopack's own advice to move user
data to roaming %APPDATA% is declined for the reason ClientPaths already gives.
**Releases are cut by a person, and CI gains no job that could.** The tempting
argument is that a forge write token is not a signing key. It does not survive
contact with what the token does: Velopack clients trust their feed and do not
verify a package signature when they apply one, so whoever can write a release
can ship an update every install runs. That is the capability ADR 0011 rule 1
puts on a machine which is not a runner, reached through a different door. The
mechanical objection — vpk needs Windows and the runners are Linux — is the
smaller of the two and is recorded beside it, because somebody will fix one and
believe they are done.
Unsigned for now, deliberately and with the cost stated where a user reads it:
SmartScreen warns once per person, on Setup.exe, because Mark-of-the-Web is
applied by the browser that downloaded it. In-app updates are fetched by the
application and applied from a local file, and never trip it.
The banner is a fourth row of the window rather than an overlay. Anything drawn
in the terminal's rectangle is sliced by the native child window that composites
above it — the defect this window has shipped once — and a sibling row is the
arrangement TitleBar and StatusBar already prove works.
----
Three defects surfaced on the way, none of them in the feature being built.
**A settings key absent from the file came back as the CLR default, not the
declared one.** The JSON source generator builds a record through a synthesised
parameterised constructor and assigns every property from its argument array, so
a property initializer runs and is then overwritten by a default for anything the
file did not contain. A settings.json of {} read back a font size of 0, clamped
up to the 8px floor rather than the 13px the renderer draws at. It could not bite
while there was one setting, because that setting was written on every save and
so was never absent; adding a second would have turned automatic update checks
off for every existing profile, silently, the opposite of the documented default.
Reflection-based deserialisation of the same JSON answers correctly, which is why
every way of checking it by hand agrees except the one that ships. The defaults
now live on the constructor parameters, which is the only place the generator
reads them from.
**Declaring a RuntimeIdentifier on the desktop head broke the server's image
build.** It is the obvious way to let a self-contained publish restore under
locked mode, and it writes a net10.0/win-x64 target into the lock file of every
project the head references transitively — including DodoSSH.Contracts and
DodoSSH.Crypto, which the API builds too. The Dockerfile restores those with no
RID and fails NU1004. Found by running docker build rather than by reading. The
RID stays out of the committed state; the two commands that need one ask for it
unlocked, and the release script puts the lock files back.
**A Docker ARG named VERSION silently sets MSBuild's Version.** An ARG is an
environment variable for the rest of the stage, MSBuild reads environment
variables as properties, and property names are case-insensitive. With the
workflow passing main-<short sha> on a main build the publish died with
NETSDK1018 pointing at DodoSSH.Contracts, a project nobody had touched. The build
stage's argument is ASSEMBLY_VERSION now, empty except on a tag build.
All three are in docs/platform-flags.md, which is where the next person will look.
----
Verified: the whole solution builds and restores locked; 289 shell, 93 layout and
54 session tests pass, including the regression test for the settings defect and
a measurement of the banner at the window's minimum width. vpk pack runs end to
end and reports "Verified VelopackApp.Run()" against Program.Main. The API image
builds correctly both as a main build and as a tag build, carrying 1.0.0 and
0.1.0 respectively.
Not verified, and it needs a published release to be: installing, updating and
uninstalling on a real machine. That is Phase 15 of docs/manual-checks.md, and
the pack id and the WebView2 profile fix are reasoned and commented but only
proved by walking it. Two things to watch at the first upload — the reverse
proxy's body-size limit for a 64 MB asset, and whether vpk upload gitea is happy
with Gitea 1.27.1.
This commit is contained in:
@@ -79,6 +79,7 @@ docs/design-import-gaps.md what the client's design asked for and this build has
|
||||
docs/platform-flags.md what differs off Windows, and the gotchas that have cost time
|
||||
docs/manual-checks.md what no test can reach, and what to look for when checking by hand
|
||||
docs/android-port.md the Android head: what was decided, what is built, what is left
|
||||
scripts/ release-windows.ps1 — builds, packs and publishes the Windows client
|
||||
```
|
||||
|
||||
Everything under `src/DodoSSH.Client.*` except the two heads and `Shell` is deliberately free of Avalonia.
|
||||
@@ -107,6 +108,40 @@ The tests need a Docker daemon. Everything that touches the database, the identi
|
||||
server uses Testcontainers rather than a stub or a shared instance, so there is nothing to start first and
|
||||
nothing to clean up after — but with no daemon those suites fail rather than skip.
|
||||
|
||||
## Installing on Windows
|
||||
|
||||
The desktop client is published on the project's own release page as a `Setup.exe`. It installs per user,
|
||||
under `%LOCALAPPDATA%\DodoSSH.Desktop`, and never asks for an administrator.
|
||||
|
||||
**It will warn you, and here is exactly what the warning means.** The build is not yet signed with a code
|
||||
signing certificate, so Windows SmartScreen shows *"Windows protected your PC"* the first time you run the
|
||||
installer; **More info → Run anyway** gets past it. That is the honest state of things rather than something
|
||||
to click through blindly — it is a statement that Microsoft has not seen this file before, and it will stop
|
||||
appearing when the project buys a certificate.
|
||||
[ADR 0012](docs/adr/0012-desktop-distribution-and-updates.md) says what that costs and when it happens. The
|
||||
warning is once per person: updates from inside the application do not raise it.
|
||||
|
||||
**Updates.** The client checks the project's release page every six hours, downloads a newer build in the
|
||||
background, and then waits. Nothing is ever installed while you are using it — a downloaded update runs
|
||||
after a restart you ask for, or the next time you start DodoSSH anyway. Restarting does end every shell you
|
||||
have open, which locking deliberately does not, so the choice of when is left to you. You can turn the
|
||||
checking off on PREFERENCES → UPDATES.
|
||||
|
||||
**Where it comes from matters, and it is worth one paragraph.** A DodoSSH server will never offer you the
|
||||
client, and one that does is not one to trust. Whoever hands you the binary can hand you a binary that
|
||||
copies your passphrase — the client is where your credentials are in plaintext, by construction — and the
|
||||
operator of a deployment is precisely the party the trust model is about. An operator may tell you where to
|
||||
get it. They are not where it comes from, and the update check inside the application points at the
|
||||
project's own forge and nowhere else. See [ADR 0011](docs/adr/0011-android-distribution.md) rule 2.
|
||||
|
||||
**Uninstalling removes the application and leaves your vault cache** at `%LOCALAPPDATA%\DodoSSH`, so
|
||||
reinstalling asks for your passphrase rather than starting over. Use **Sign out** inside the application if
|
||||
you want the machine to genuinely forget everything — an uninstall is not a sign-out, and does not withdraw
|
||||
this machine's device key from your account.
|
||||
|
||||
Cutting a release is `scripts/release-windows.ps1`, run by a person on a Windows machine. Deliberately not a
|
||||
CI job; ADR 0012 decision 3 explains why, and it is not only that the runners are Linux.
|
||||
|
||||
## Running it
|
||||
|
||||
Three commands, in order. The first is once per machine.
|
||||
@@ -515,6 +550,11 @@ keychain plus a terminal — and the spike that gates all of it.
|
||||
|
||||
### Conventions the build enforces
|
||||
|
||||
- One version for the whole repository, derived from the nearest `v*` tag by MinVer. A tag build whose
|
||||
computed version disagrees with the tag fails CI, and every checkout uses `fetch-depth: 0` — without it
|
||||
MinVer answers `0.0.0-alpha.0.N` rather than failing, and a wrong version here is a client that never
|
||||
updates.
|
||||
|
||||
- Warnings are errors, formatting included: `IDE0055` is an error in `.editorconfig`, so a
|
||||
misformatted file fails the build itself rather than a separate CI step.
|
||||
- Package versions are centralised in `Directory.Packages.props`; `packages.lock.json` is
|
||||
@@ -659,6 +699,20 @@ keychain plus a terminal — and the spike that gates all of it.
|
||||
serving the client binary, which hands it to the one party the whole trust model is about. An installed
|
||||
Android app can only ever be updated by a package signed with the same key, so this is the first
|
||||
release's decision to make and nobody else's afterwards.
|
||||
|
||||
**The Windows desktop half is built.** Velopack packaging for `win-x64`, a `Setup.exe` that installs per
|
||||
user with no administrator prompt, and a client that checks the project's own forge every six hours,
|
||||
fetches a newer build in the background, and then waits for a restart the user presses — because a
|
||||
restart ends every shell, and this application has gone to some trouble to make locking not do that. The
|
||||
version is now one number for the whole repository, derived from the `v*` tag by MinVer, which is also
|
||||
the first time the API has reported a true `serverVersion`. Releases are cut by a person rather than by
|
||||
CI: the token that writes a release is, for an updater that trusts its feed, the same capability as the
|
||||
signing key, which [ADR 0011](docs/adr/0011-android-distribution.md) rule 1 keeps off runners. See
|
||||
[ADR 0012](docs/adr/0012-desktop-distribution-and-updates.md), and
|
||||
[Installing on Windows](#installing-on-windows) for what a user sees.
|
||||
|
||||
Still to do here: signing (the first release is unsigned, and the trigger for buying a certificate is the
|
||||
first release aimed at strangers), and macOS and Linux packaging.
|
||||
- **M5 — multi-provider OIDC**, identity key rotation, per-item content keys.
|
||||
|
||||
## Licence
|
||||
|
||||
Reference in New Issue
Block a user