Show DATUM login credentials and document complete app launch requirements

This commit is contained in:
yaya
2026-10-06 08:13:20 +01:00
parent 3fc37642cd
commit 2fad10c8de
6 changed files with 83 additions and 0 deletions
+42
View File
@@ -789,3 +789,45 @@ adapter instead of reporting a successful installation with no usable backend.
For example, Angor Indexer requires `mempool-api` (shown to users as its owning
Mempool app), shares that index and declares only an `api` interface. API-only
interfaces belong in Services and do not generate browser launch buttons.
## Launch acceptance: credentials, signer, and HTTP nodes
An app is not ready just because its container is healthy. Before submission,
verify its first launch from My Apps, app details, a browser tab and Companion:
- Declare a real UI interface and stage the app icon in the web UI assets. Check
the installing tile as well as the completed installation: a UI app belongs
in My Apps and must not appear as an iconless service.
- If the app needs a password or first-run token, provide the shared credential
interstitial **before** launch, with copy controls and setup instructions.
Generating a secret in the manifest does not register this screen. Implement
`package.credentials` in `core/archipelago/src/api/rpc/package/install.rs`
and register the app in `CREDENTIAL_INTERSTITIAL_APPS` in
`neode-ui/src/stores/appLauncher.ts`. Both changes require a platform update;
app-only sideloads cannot add this RPC integration. File Browser and DATUM
are examples. Read generated secrets from the node's configured data directory;
never put them in a manifest, static browser bundle, default-password fallback,
logs, screenshots, or test reports. Keep the RPC dashboard-authenticated.
- Explain initial configuration and client connection details. For DATUM this
includes its administrator password, Bitcoin payout address, and the node's
Stratum address on port 23334. App-to-app connections use container DNS
(`http://datum:7152`), never a container IP address.
- Native Nostr apps should open the host identity chooser once on an explicit
app launch when unauthenticated, then finish the app's ordinary NIP-07 login.
The app may call `archipelagoNostr.selectIdentity()` at initial mount for this
first-launch flow; this is the exception to the routine-signing rule above.
Do not assume the platform's eager-picker app list contains a new app ID.
Consume an already selected identity through `getSelectedIdentity()` or the
sticky `onIdentitySelected()` subscription to avoid a second chooser.
Preserve manual login/account switching, external extensions and remote
signers. Cancellation must leave a usable login screen without reopening a
prompt loop; signing still requires the platform's normal consent.
- Test the actual HTTP LAN/Tailscale address, not only localhost or HTTPS.
`crypto.subtle` and clipboard APIs may be unavailable on those addresses.
Keep authenticated encryption: use a vetted compatible implementation when
WebCrypto is absent, and secure randomness (`crypto.getRandomValues`). Test
existing-message decryption, tamper rejection and an HTTP round trip.
- Verify first launch, cancellation/retry, reload, owner/viewer authorization,
and persisted data after app recreation. Use the shared browser-check suite
outside the repository; record which nodes and browser engines were tested.
+2
View File
@@ -1,5 +1,7 @@
# Archipelago Developer Guide
For new apps, start with `docs/app-developer-guide.md` and complete its **Launch acceptance: credentials, signer, and HTTP nodes** checklist. Packaging includes My Apps presentation, login/first-run credential handoff, native signer startup, and real HTTP-node testing—not only a working container.
## Project Structure
```