Skip to content

Commit 0444748

Browse files
committed
docs(api): document Fedify WebFinger proof
1 parent 79a2e21 commit 0444748

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

packages/api/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ Optional env:
8282

8383
- `GET /health`
8484
- `POST /federation/inbox` (ForgeFed `Ticket` / `Offer(Ticket)`, ActivityPub `Accept` / `Reject`)
85+
- `GET /.well-known/webfinger` (Fedify WebFinger document for the local federation actor)
8586
- `GET /federation/issues`
8687
- `GET /federation/actor` (ActivityPub `Person`)
8788
- `GET /federation/outbox`
@@ -116,6 +117,14 @@ Optional env:
116117

117118
Exchange targets must be explicit. Use `https://exchange.lefine.pro`, an actor URL, or a handle like `code@exchange.lefine.pro`; the API resolves the code actor document, stores its `inbox/outbox/followers/publicKey`, sends `Follow`, and polls the stored `outbox`.
118119

120+
Local ActivityPub documents are serialized with Fedify and use only the supported ActivityStreams and security JSON-LD contexts. Mastodon-specific extension contexts and keys such as `https://purl.archive.org/socialweb/webfinger`, `toot`, `featured`, `featuredTags`, `alsoKnownAs`, `movedTo`, and `interactionPolicy` are not emitted by docker-git.
121+
122+
The local actor is discoverable through WebFinger:
123+
124+
```bash
125+
./ctl request GET '/.well-known/webfinger?resource=acct:docker-git@social.provercoder.ai'
126+
```
127+
119128
```bash
120129
./ctl request POST /federation/exchange/subscriptions '{
121130
"domain":"https://social.provercoder.ai",

0 commit comments

Comments
 (0)