fedipod 1.5.0 → 1.6.0

package/web/app/index.html

@@ -170,7 +170,7 @@ a { color: var(--accent); }
           <input type="url" id="pod" name="pod" autocomplete="url" aria-describedby="pod-hint"
             placeholder="https://alice.solidcommunity.net/ or https://server.example/alice/">
           <p class="hint" id="pod-hint">The address of your pod: its own host, or a path on a
-            shared host.</p>
+            suffix-based host.</p>
         </div>
 
         <label for="email">Email (used as pod id)</label>

package/web/app/signup.mjs

@@ -53,7 +53,7 @@ const progressKey = (a) => [a.issuer, a.mode, a.handle, a.mode === 'new' ? (a.po
  * `shape` is where the address lives. On the pod, `@handle@yourpod`, with the
  * gateway as a mail door only — the default. At the gateway, `@handle@front`,
  * a fronted identity whose documents still live on the pod. A pod on a path of
- * a shared host cannot answer WebFinger, so it is fronted whatever was asked.
+ * a suffix-based host cannot answer WebFinger, so it is fronted whatever was asked.
  *
  * returns: { credential, config, actorUrl, address, keysPublic }
  */
@@ -116,7 +116,7 @@ export async function signUp(answers, { onStep = () => {}, frontOrigin = null }
   const pathPod = new URL(pod).pathname !== '/';
   const fronted = pathPod || wantsFront;
   if (fronted && !frontOrigin) {
-    throw new Error(`${pod} is a path on a shared host, so its address must live at a gateway, and this page has none.`);
+    throw new Error(`${pod} is a suffix-based host, so its address must live at a gateway, and this page has none.`);
   }
   if (pathPod && !wantsFront) await assertFrontNameFree(frontOrigin, handle);
 

package/web/app/site/admin/setup/index.html

@@ -132,9 +132,20 @@ button:disabled { opacity: .5; cursor: default; }
         <label for="issuer-new">Solid pod provider</label>
         <select id="issuer-new" name="issuerNew" aria-describedby="issuer-new-hint">
           <option value="https://solidcommunity.net">solidcommunity.net</option>
+          <option value="https://privatedatapod.com">privatedatapod.com</option>
+          <option value="https://solid.redpencil.io">redpencil.io</option>
+          <option value="https://pods.solidcommunity.au">solidcommunity.au</option>
+          <option value="https://solidweb.me">solidweb.me</option>
+          <option value="https://teamid.live">teamid.live</option>
+          <option value="">Other…</option>
         </select>
-        <p class="hint" id="issuer-new-hint">Providers that give each pod its own subdomain, so the
-          Fediverse address works everywhere.</p>
+        <div id="row-issuer-other" hidden>
+          <label for="issuerOther">Provider address</label>
+          <input type="url" id="issuerOther" name="issuerOther" autocomplete="url" placeholder="https://pods.example.org">
+        </div>
+        <p class="hint" id="issuer-new-hint">The Community Solid Server providers from
+          solidproject.org. A provider that puts pods on paths gives your address at a
+          gateway instead.</p>
       </div>
 
       <div id="row-issuer-existing" hidden>
@@ -172,6 +183,18 @@ button:disabled { opacity: .5; cursor: default; }
       Wrong account or pod?
       <button type="button" id="form-reenter" title="   Discard the credential and enter the account and pod again">Re-enter credentials</button></p>
 
+    <fieldset id="fs-shape" hidden>
+      <legend>Where your address lives</legend>
+      <label class="choice"><input type="radio" name="shape" value="pod" checked> On your pod</label>
+      <label class="choice"><input type="radio" name="shape" value="front"> At a gateway</label>
+      <div id="row-gateway" hidden>
+        <label for="gatewayOrigin">Gateway</label>
+        <input type="url" id="gatewayOrigin" name="gatewayOrigin" value="https://fedipod.net" autocomplete="url">
+        <p class="hint">The gateway answers your address and forwards your mail to your pod.</p>
+      </div>
+      <p class="hint" id="shape-note" hidden></p>
+    </fieldset>
+
     <h2>You will be</h2>
     <p class="address" id="preview">…</p>
     <div id="preview-notes"></div>

package/web/app/site/admin/setup/setup.js

@@ -93,12 +93,18 @@ function answers() {
   const f = $('form').elements;
   const kind = f.kind.value;
   const mode = state.resumable ? 'existing' : f.mode.value;
+  const issuer = mode === 'new'
+    ? (f.issuerNew.value || (f.issuerOther ? f.issuerOther.value : '')).trim()
+    : f.issuer.value.trim();
   const a = {
     kind,
     mode,
     handle: f.handle.value.trim(),
-    issuer: (mode === 'new' ? f.issuerNew.value : f.issuer.value).trim(),
+    issuer,
     email: f.email.value.trim(),
+    // Where the address lives; a group cannot front (yet), so it stays 'pod'.
+    shape: (kind === 'group') ? 'pod' : (f.shape ? f.shape.value : 'pod'),
+    gatewayOrigin: (f.gatewayOrigin ? f.gatewayOrigin.value.trim() : '') || 'https://fedipod.net',
   };
   if (mode === 'new') a.podName = f.podName.value.trim() || a.handle;
   else a.pod = f.pod.value.trim();
@@ -128,6 +134,9 @@ function onEdit() {
   $('row-pod').hidden = mode === 'new';
   $('row-issuer-new').hidden = mode !== 'new';
   $('row-issuer-existing').hidden = mode === 'new';
+  const f = $('form').elements;
+  if ($('row-issuer-other')) $('row-issuer-other').hidden = !(mode === 'new' && f.issuerNew.value === '');
+  if ($('row-gateway')) $('row-gateway').hidden = !(f.shape && f.shape.value === 'front');
   clearTimeout(editTimer);
   editTimer = setTimeout(preview, 150);
 }
@@ -140,6 +149,26 @@ async function preview() {
   const { json } = await postJson('/setup/check', a);
   if (!json) return;
   $('preview').textContent = json.address || '…';
+  // The address-shape choice: hidden for a group (a group cannot front yet),
+  // locked to the gateway for a pod on a suffix-based host, an open choice
+  // for a pod at its own host.
+  const f = $('form').elements;
+  const shapeFs = $('fs-shape');
+  if (shapeFs) {
+    const isGroup = a.kind === 'group';
+    shapeFs.hidden = isGroup || (a.mode === 'existing' && !a.pod);
+    const forced = !!json.forced;
+    for (const r of f.shape) r.disabled = forced;
+    if (forced) { for (const r of f.shape) r.checked = r.value === 'front'; }
+    if ($('row-gateway')) $('row-gateway').hidden = !(f.shape.value === 'front');
+    const note = $('shape-note');
+    if (note) {
+      note.hidden = !forced;
+      note.textContent = forced
+        ? 'Your pod is on a suffix-based host, so its address lives at the gateway. Your posts, key and data stay on your pod.'
+        : '';
+    }
+  }
   const notes = $('preview-notes');
   for (const w of json.warnings || []) {
     const p = document.createElement('p');

package/web/app/site/boot.js

@@ -33321,7 +33321,7 @@ async function signUp(answers, { onStep = () => {
   const pathPod = new URL(pod).pathname !== "/";
   const fronted = pathPod || wantsFront;
   if (fronted && !frontOrigin) {
-    throw new Error(`${pod} is a path on a shared host, so its address must live at a gateway, and this page has none.`);
+    throw new Error(`${pod} is a suffix-based host, so its address must live at a gateway, and this page has none.`);
   }
   if (pathPod && !wantsFront) await assertFrontNameFree(frontOrigin, handle);
   const actorUrl = actorUrlFor(pod);

package/web/app/site/index.html

@@ -170,7 +170,7 @@ a { color: var(--accent); }
           <input type="url" id="pod" name="pod" autocomplete="url" aria-describedby="pod-hint"
             placeholder="https://alice.solidcommunity.net/ or https://server.example/alice/">
           <p class="hint" id="pod-hint">The address of your pod: its own host, or a path on a
-            shared host.</p>
+            suffix-based host.</p>
         </div>
 
         <label for="email">Email (used as pod id)</label>

package/web/app/site/sw.js

@@ -56507,7 +56507,7 @@ var Publisher = class {
     }
     const pubName = publicHandle(this.config);
     const pubHost = this.config.gateway?.frontActor ? new URL(this.config.gateway.frontActor).host : host;
-    this.log(this.config.gateway?.frontActor || webfingerHost(urls.base) ? `profile published: @${pubName}@${pubHost} \u2192 ${urls.actor}` : `profile published \u2192 ${urls.actor} \u2014 NOT discoverable as @${pubName}@${pubHost}: this pod is a path on a shared host, and WebFinger is only answered at a host root`);
+    this.log(this.config.gateway?.frontActor || webfingerHost(urls.base) ? `profile published: @${pubName}@${pubHost} \u2192 ${urls.actor}` : `profile published \u2192 ${urls.actor} \u2014 NOT discoverable as @${pubName}@${pubHost}: this pod is a suffix-based host, and WebFinger is only answered at a host root`);
     return { unreachable, updated };
   }
   // Fires when the document differs from the one last published — including
@@ -68273,7 +68273,7 @@ var AdminFacade = class {
         const aliases = [...cfg.aliases || []];
         if (body.add) {
           if (!webfingerHost(urls.base) && !cfg.gateway?.frontActor) {
-            return json2(400, { error: "this pod is a path on a shared host, so other servers could never resolve it as a Move target" });
+            return json2(400, { error: "this pod is a suffix-based host, so other servers could never resolve it as a Move target" });
           }
           const id = await this.resolveActor(body.add);
           if (!id) return json2(400, { error: `could not fetch the old account (${body.add}) \u2014 enter its URL or @user@host, and it must answer` });
@@ -69785,7 +69785,7 @@ var BrowserAgent = class _BrowserAgent {
       publicKeyPem: keys.rsaPublicPem,
       assertionKey: null,
       log: this.log,
-      // Who a post names, resolved — the same lookup the installed agent
+      // Who a post names, resolved — the same lookup the DeviceAgent
       // gives its publisher. Without it no mention from the browser ever
       // resolved: a direct message went to nobody, a mention notified no one.
       resolveMention: (h) => resolveHandle(this, h)

package/installed-agent.md

@@ -1,97 +0,0 @@
-# The installed agent
-
-FediPod can also run as a program on your own machine, in front of the same
-kind of pod. It does everything the browser version at fedipod.net does, plus
-what a browser tab cannot: it keeps running while no tab is open, so scheduled
-posts go out and push notifications reach you; it serves the Mastodon streaming
-API, so clients update live; any Mastodon client, phone app or desktop, can
-connect to it; and it can host a [group](groups.md).
-
-## Requirements
-
-- Node 20 or newer.
-- A Solid pod with a host name of its own, such as
-  `https://alice.solidcommunity.net/`. A pod on a path of a shared host cannot
-  be a Fediverse address.
-- Followers-only and direct posts need a pod that enforces WAC access control;
-  on one that does not, the composer refuses those two and says why.
-- While the agent is off, your mail waits on your pod's host. Run it as a
-  service, or attach to a gateway, so it does not pile up there.
-
-## Installing
-
-```
-npm install -g fedipod
-```
-
-## Running
-
-Run `fedipod start`. Add a port to change the local agent's port, for example
-`fedipod start --port 8081`; the default is 8030. Then point any browser at
-`https://localhost:8030`, or the port you chose, and the setup pages take it
-from there.
-
-## Running as a service
-
-```
-fedipod install-service
-```
-
-It registers every identity on this machine, one service each, so all of your
-actors start at boot. An identity running in a terminal is stopped and taken
-over by its service. `fedipod uninstall-service` reverses it.
-
-## Managing
-
-Posts, logs, parking, moving, transferring and the rest are on the
-[admin interface](gui.md); starting, stopping and what a page cannot do are in
-[CLI admin](cli.md). The admin tools also create other actors, groups or
-persons. You may have as many as you want on one machine, each with a pod of
-its own.
-
-Every agent checks once a day whether a newer FediPod is published. When one
-exists, the record page offers **Update**, and `fedipod update` does the same
-from the terminal. `AP_UPDATE_CHECK=0` turns the check off.
-
-## A gateway account
-
-Most of what a Fediverse inbox receives is broadcast noise. A
-[gateway](gateway.md) is a shared, always-on door that verifies each delivery,
-drops the junk, and passes the rest to your pod, while your key and data stay
-on your pod. There is a free one at [fedipod.net](https://fedipod.net/).
-Attaching or detaching is a few wizard-guided clicks from your agent, and it
-takes the mail load off your pod's host.
-
-## Clients
-
-The bundled client is [Phanpy](https://github.com/cheeaun/phanpy) (MIT, by
-Chee Aun), served by the agent itself, and logging in is one click. If you
-ever enter the instance by hand, use the address on the record's **local
-host** row.
-
-- **Other web clients**: drop any static Mastodon client dist into
-  `ui/<name>/` and it is served at `/<name>/`; see `ui/README.md`.
-- **Desktop and phone clients** (Tuba, Whalebird, and the like): add
-  `https://localhost:8030`, or your agent's port, as a custom instance.
-- **Streaming**: the agent serves the Mastodon streaming API at
-  `/api/v1/streaming`, so clients update live instead of polling.
-- **Web push**: notifications reach you while the client is closed.
-- **Scheduled posts** go out at the time you picked.
-
-Polls, content warnings, editing, all four visibility levels, direct
-messages, bookmarks, favourites, lists, keyword filters, pinned posts,
-blocking and muting, and custom emojis work as in the browser version.
-
-## Bluesky, and your other Fediverse accounts
-
-A Bluesky connection lets the agent drive an existing Bluesky, or other
-ATProto, account alongside your Fediverse identity: public posts are
-cross-posted as a mirror, with a toggle to turn it off; Bluesky replies and
-activity flow into your timeline; you can like, boost and reply to Bluesky
-posts. Direct messages to Bluesky are not supported.
-
-An account on Mastodon or any server speaking the Mastodon API can be
-connected from the **Other identities** row of the admin page. Its home
-timeline and notifications join your feed, a post both accounts see appears
-once, and favouriting, boosting and replying act as the account the post came
-through. The token it hands back stays on this machine.