@fedify/relay 2.0.0-dev.150 → 2.0.0-dev.159
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -15
- package/dist/litepub.test.d.ts +3 -0
- package/dist/litepub.test.js +701 -0
- package/dist/mastodon.test.d.ts +3 -0
- package/dist/mastodon.test.js +664 -0
- package/dist/mod.cjs +18 -18
- package/dist/mod.d.cts +1 -1
- package/dist/mod.d.ts +1 -1
- package/dist/mod.js +4 -4
- package/dist/types-DZ7AG5rc.js +28333 -0
- package/package.json +10 -11
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!-- deno-fmt-ignore-file -->
|
|
2
2
|
|
|
3
3
|
@fedify/relay: ActivityPub relay for Fedify
|
|
4
|
-
|
|
4
|
+
===========================================
|
|
5
5
|
|
|
6
6
|
[![JSR][JSR badge]][JSR]
|
|
7
7
|
[![npm][npm badge]][npm]
|
|
@@ -16,9 +16,18 @@ forward activities between federated instances.
|
|
|
16
16
|
For comprehensive documentation on building and operating relay servers,
|
|
17
17
|
see the [*Relay server* section in the Fedify manual][manual].
|
|
18
18
|
|
|
19
|
+
[JSR badge]: https://jsr.io/badges/@fedify/relay
|
|
20
|
+
[JSR]: https://jsr.io/@fedify/relay
|
|
21
|
+
[npm badge]: https://img.shields.io/npm/v/@fedify/relay?logo=npm
|
|
22
|
+
[npm]: https://www.npmjs.com/package/@fedify/relay
|
|
23
|
+
[@fedify@hollo.social badge]: https://fedi-badge.deno.dev/@fedify@hollo.social/followers.svg
|
|
24
|
+
[@fedify@hollo.social]: https://hollo.social/@fedify
|
|
25
|
+
[Fedify]: https://fedify.dev/
|
|
26
|
+
[manual]: https://fedify.dev/manual/relay
|
|
27
|
+
|
|
19
28
|
|
|
20
29
|
What is an ActivityPub relay?
|
|
21
|
-
|
|
30
|
+
-----------------------------
|
|
22
31
|
|
|
23
32
|
ActivityPub relays are infrastructure components that help small instances
|
|
24
33
|
participate effectively in the federated social network by acting as
|
|
@@ -131,8 +140,8 @@ const relay = createRelay("litepub", {
|
|
|
131
140
|
|
|
132
141
|
### Subscription handling
|
|
133
142
|
|
|
134
|
-
The `subscriptionHandler` is required and determines whether to approve or
|
|
135
|
-
subscription requests. For an open relay that accepts all subscriptions:
|
|
143
|
+
The `subscriptionHandler` is required and determines whether to approve or
|
|
144
|
+
reject subscription requests. For an open relay that accepts all subscriptions:
|
|
136
145
|
|
|
137
146
|
~~~~ typescript
|
|
138
147
|
const relay = createRelay("mastodon", {
|
|
@@ -251,6 +260,8 @@ For production use, choose a persistent storage backend like Redis or
|
|
|
251
260
|
PostgreSQL. See the [Fedify documentation on key–value stores] for more
|
|
252
261
|
details.
|
|
253
262
|
|
|
263
|
+
[Fedify documentation on key–value stores]: https://fedify.dev/manual/kv
|
|
264
|
+
|
|
254
265
|
|
|
255
266
|
API reference
|
|
256
267
|
-------------
|
|
@@ -350,14 +361,3 @@ interface RelayFollower {
|
|
|
350
361
|
- `actorId`: The actor ID (URL) of the follower
|
|
351
362
|
- `actor`: The validated Actor object
|
|
352
363
|
- `state`: The follower's state (`"pending"` or `"accepted"`)
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
[JSR]: https://jsr.io/@fedify/relay
|
|
356
|
-
[JSR badge]: https://jsr.io/badges/@fedify/relay
|
|
357
|
-
[npm]: https://www.npmjs.com/package/@fedify/relay
|
|
358
|
-
[npm badge]: https://img.shields.io/npm/v/@fedify/relay?logo=npm
|
|
359
|
-
[@fedify@hollo.social badge]: https://fedi-badge.deno.dev/@fedify@hollo.social/followers.svg
|
|
360
|
-
[@fedify@hollo.social]: https://hollo.social/@fedify
|
|
361
|
-
[Fedify]: https://fedify.dev/
|
|
362
|
-
[Fedify documentation on key–value stores]: https://fedify.dev/manual/kv
|
|
363
|
-
[manual]: https://fedify.dev/manual/relay
|