Add Groups docs

pixelfed · Jul 23, 2024 · a5d2f7d · a5d2f7d
1 parent f9dc440
commit a5d2f7d
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 0 deletions.
diff --git a/snippets/activitypub/group_activity.json b/snippets/activitypub/group_activity.json
@@ -0,0 +1,23 @@
+{
+    "@context": "https://www.w3.org/ns/activitystreams",
+    "id": "https://pixelfed.test/groups/687201346065063941/p/721271403909644290",
+    "type": "Note",
+    "summary": null,
+    "content": "Hello World!",
+    "inReplyTo": null,
+    "published": "2024-07-23T07:55:03+00:00",
+    "url": "https://pixelfed.test/groups/687201346065063941/p/721271403909644290",
+    "attributedTo": "https://pixelfed.test/users/dansup",
+    "to": [
+        "https://www.w3.org/ns/activitystreams#Public",
+        "https://pixelfed.test/groups/687201346065063941/followers"
+    ],
+    "cc": [],
+    "sensitive": false,
+    "attachment": [],
+    "target": {
+        "type": "Collection",
+        "id": "https://pixelfed.test/groups/687201346065063941/wall",
+        "attributedTo": "https://pixelfed.test/groups/687201346065063941"
+    }
+}
diff --git a/snippets/activitypub/group_actor.json b/snippets/activitypub/group_actor.json
@@ -0,0 +1,20 @@
+{
+    "@context": "https://www.w3.org/ns/activitystreams",
+    "id": "https://pixelfed.test/groups/687201346065063941",
+    "inbox": "https://pixelfed.test/groups/687201346065063941/inbox",
+    "name": "Test",
+    "outbox": "https://pixelfed.test/groups/687201346065063941/outbox",
+    "summary": "Test Group",
+    "type": "Group",
+    "attributedTo": {
+        "type": "Person",
+        "id": "https://pixelfed.test/users/dansup"
+    },
+    "preferredUsername": "gid_687201346065063941",
+    "publicKey": {
+        "id": "https://pixelfed.test/groups/687201346065063941#main-key",
+        "owner": "https://pixelfed.test/groups/687201346065063941",
+        "publicKeyPem": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8NNVngXISNiZFIAHhDU/\nye/2g7bVn045BbR6L0izftITaOas7eg+ZF976ahJ5udojaHpHonaTFp/x9zZltH2\n6/cc7/s37tdiIcTFuuGKM2n/zxrSd6sy/URFhwLaQkxTqWYugEmV/+jkdBTLz173\nyC1b9Gi5UfK8CyYrV5Po1xYYh9ZCB5NFZcvRwllcudWLpp+/5IH5D49O8C9kLqUc\nPgHw3ClHeRb7cN17o9ExKj+RtEn+fNqd1yBBgRXgMM5yC/aPhoZ86TF23/G1r6ia\nPLahR9Tgil+Oqae/SkQrEBEdy+TYICRITbjrsTK2WUhR4JYE2YFm9aiGzyeEhA2K\nAwIDAQAB\n-----END PUBLIC KEY-----\n"
+    },
+    "url": "https://pixelfed.test/groups/687201346065063941"
+}
diff --git a/spec/ActivityPub.md b/spec/ActivityPub.md
@@ -285,6 +285,22 @@ Pixelfed supports location geo-tagging statuses by selecting a location from a s
 <<< @/snippets/activitypub/location_note.json
 :::
 
+## Groups
+
+Pixelfed supports federated Groups, allowing users to create and join communities that can interact across different Pixelfed instances and other ActivityPub-compatible platforms. This functionality is enabled by the `FEP-400e` and `FEP-1b12` extensions, which provide the necessary protocols and standards for seamless federation.
+
+### Group Actor
+
+::: details Click to expand group actor example
+<<< @/snippets/activitypub/group_actor.json
+:::
+
+### Group Activity
+
+::: details Click to expand group activity example
+<<< @/snippets/activitypub/group_activity.json
+:::
+
 ## Authorized Fetch
 
 Pixelfed, like other platforms in the Fediverse including Mastodon, uses digital signatures to ensure secure and authenticated federation requests. This compatibility with Mastodon's Authorized Fetch protocol is a crucial aspect of maintaining a secure and interoperable federated network.