ep_rss 11.0.25 → 11.0.26
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 +51 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,18 +1,51 @@
|
|
|
1
|
-
# RSS
|
|
1
|
+
# RSS feeds for Etherpad pads
|
|
2
2
|
|
|
3
|
-
](https://www.npmjs.com/package/ep_rss)
|
|
4
|
+
[](https://github.com/ether/ep_rss/actions/workflows/backend-tests.yml)
|
|
5
|
+
[](https://github.com/ether/ep_rss/actions/workflows/frontend-tests.yml)
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
Adds an RSS 2.0 feed for every pad so readers can subscribe to changes
|
|
8
|
+
in any feed reader.
|
|
6
9
|
|
|
7
10
|
## Install
|
|
8
11
|
|
|
9
|
-
|
|
12
|
+
From your Etherpad root, install the plugin via the Etherpad plugin
|
|
13
|
+
manager:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
10
16
|
pnpm run plugins i ep_rss
|
|
11
17
|
```
|
|
12
18
|
|
|
19
|
+
Or install from the admin UI: **Admin → Manage Plugins**, search for
|
|
20
|
+
`ep_rss`, click *Install*. Restart Etherpad after installing.
|
|
21
|
+
|
|
22
|
+
> ⚠️ Don't run `npm i` / `pnpm add` against this plugin from inside
|
|
23
|
+
> the Etherpad source tree — Etherpad tracks installed plugins
|
|
24
|
+
> through its own plugin manager, and hand-editing `package.json`
|
|
25
|
+
> can leave the server unable to start.
|
|
26
|
+
|
|
27
|
+
## Endpoints
|
|
28
|
+
|
|
29
|
+
Once installed, each pad exposes:
|
|
30
|
+
|
|
31
|
+
| Path | Behavior |
|
|
32
|
+
|---|---|
|
|
33
|
+
| `/p/<pad>/feed` | 200 with `Content-Type: application/rss+xml` and the current pad text as a single `<item>` |
|
|
34
|
+
| `/p/<pad>/rss` | 302 → `/p/<pad>/feed` |
|
|
35
|
+
| `/p/<pad>/feed.rss` | 302 → `/p/<pad>/feed` |
|
|
36
|
+
| `/p/<pad>/atom.xml` | 302 → `/p/<pad>/feed` |
|
|
37
|
+
|
|
38
|
+
The pad page itself also advertises the feed in `<head>` so feed
|
|
39
|
+
readers auto-discover it:
|
|
40
|
+
|
|
41
|
+
```html
|
|
42
|
+
<link rel="alternate" type="application/rss+xml" title="Pad RSS Feed" href="feed" />
|
|
43
|
+
```
|
|
44
|
+
|
|
13
45
|
## Settings
|
|
14
46
|
|
|
15
|
-
Optional
|
|
47
|
+
Optional. Add to `settings.json` to control how long a generated feed
|
|
48
|
+
is cached in memory before being regenerated:
|
|
16
49
|
|
|
17
50
|
```json
|
|
18
51
|
"rss": {
|
|
@@ -20,7 +53,19 @@ Optional stale time (milliseconds before a new RSS item is generated) can be set
|
|
|
20
53
|
}
|
|
21
54
|
```
|
|
22
55
|
|
|
23
|
-
Defaults to 5 minutes
|
|
56
|
+
`staleTime` is in milliseconds. Defaults to 5 minutes
|
|
57
|
+
(`300000`) when unset.
|
|
58
|
+
|
|
59
|
+
## Development
|
|
60
|
+
|
|
61
|
+
```sh
|
|
62
|
+
pnpm install
|
|
63
|
+
pnpm run lint
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Backend and frontend tests live under `static/tests/` and run inside
|
|
67
|
+
an Etherpad checkout — the CI workflows install this plugin into a
|
|
68
|
+
fresh Etherpad and exercise it end-to-end.
|
|
24
69
|
|
|
25
70
|
## License
|
|
26
71
|
|