diff --git a/src/pages/sdk/connect-quickstart/index.astro b/src/pages/sdk/connect-quickstart/index.astro
index 7d220c1..d92cbe2 100644
--- a/src/pages/sdk/connect-quickstart/index.astro
+++ b/src/pages/sdk/connect-quickstart/index.astro
@@ -64,6 +64,12 @@ pnpm package:consumer -- \\
--destination ../workouts-app/vendor \\
--packages connect,protocol`;
+const localStack = `# Run in the mdbase-connect checkout.
+pnpm dev:environment:up
+
+# Run in another terminal.
+pnpm dev:desktop:fresh`;
+
const validate = `mdbase-connect-dev validate-manifest \\
public/.well-known/mdbase-app.json \\
--allow-local`;
@@ -79,8 +85,16 @@ export interface Workout extends JsonObject {
completed?: boolean;
}
+const loopback = new Set([
+ "localhost",
+ "127.0.0.1",
+ "::1"
+]).has(location.hostname);
+
export const mdbase = new MdbaseConnect
- The production service currently accepts private-beta accounts. The
- public SDK packages are also awaiting their first npm release. Start with
- the local sandbox guide if you do not have
- beta access.
+ This guide's localhost example uses the repository's local Connect stack.
+ The managed service rejects HTTP application manifests, including
+ localhost. To use This guide expects:
+ In the Connect checkout, copy
+ Enter
The example manifest carries a complete transactional contract/type pack.
Connect can install it during approval when the chosen collection does not
@@ -207,9 +234,9 @@ if (first) {
Save this file at
- {" "}
@@ -230,9 +257,11 @@ if (first) {
The validator is currently run from the Connect workspace or supplied as a
- beta artifact:
+ beta artifact. https://connect.mdbase.dev, deploy the
+ application at HTTPS URLs and declare those exact URLs in its manifest.
Before you begin
-
+ http://localhost:5173;.env.example to .env
+ {" "}on first use, then start the local control plane and an isolated desktop
+ profile:
+ http://127.0.0.1:8787 in the desktop pairing screen,
+ approve the computer in the local portal, and add a collection. This profile
+ is separate from the normal desktop profile: accounts, grants, and
+ collections registered with the managed service do not appear automatically.
+ 1. Add a bundled application manifest
public/.well-known/mdbase-app.json. The local URLs are valid
- for development and require the validator's
- {" "}--allow-local option.
+ {" "}public/.well-known/mdbase-app.json. These loopback URLs are
+ accepted by the local Connect stack. Pass --allow-local to the
+ validator when checking this development manifest.
--allow-local affects static validation only; it
+ is not an option on the desktop application and does not change the managed
+ service's HTTPS policy:
3. Create one stable Connect client
+ The production service currently accepts private-beta accounts. Before using
+ it, deploy the application at an HTTPS origin, replace every localhost
+ homepage, icon, and redirect URL in the manifest with the exact deployed
+ URLs, and validate without --allow-local. The non-loopback branch
+ in the client example then uses https://connect.mdbase.dev.
+
+ A localhost application cannot connect to the managed service. Use the full + local environment above for local protocol testing, or use the + {" "}in-memory sandbox for feature tests that + do not need authorization, routing, or a real connector. +
+