-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.html
265 lines (265 loc) · 7.86 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content=
"width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>rssc - rss customizer</title>
<style>
<![CDATA[
html {
color: #1a1a1a;
background-color: #fdfdfd;
}
body {
margin: 0 auto;
max-width: 36em;
padding-left: 50px;
padding-right: 50px;
padding-top: 50px;
padding-bottom: 50px;
hyphens: auto;
overflow-wrap: break-word;
text-rendering: optimizeLegibility;
font-kerning: normal;
}
@media (max-width: 600px) {
body {
font-size: 0.9em;
padding: 12px;
}
h1 {
font-size: 1.8em;
}
}
@media print {
html {
background-color: white;
}
body {
background-color: transparent;
color: black;
font-size: 12pt;
}
p, h2, h3 {
orphans: 3;
widows: 3;
}
h2, h3, h4 {
page-break-after: avoid;
}
}
p {
margin: 1em 0;
}
a {
color: #1a1a1a;
}
a:visited {
color: #1a1a1a;
}
img {
max-width: 100%;
}
h1, h2, h3, h4, h5, h6 {
margin-top: 1.4em;
}
h5, h6 {
font-size: 1em;
font-style: italic;
}
h6 {
font-weight: normal;
}
ol, ul {
padding-left: 1.7em;
margin-top: 1em;
}
li > ol, li > ul {
margin-top: 0;
}
blockquote {
margin: 1em 0 1em 1.7em;
padding-left: 1em;
border-left: 2px solid #e6e6e6;
color: #606060;
}
code {
font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
font-size: 85%;
margin: 0;
hyphens: manual;
}
pre {
margin: 1em 0;
overflow: auto;
}
pre code {
padding: 0;
overflow: visible;
overflow-wrap: normal;
}
.sourceCode {
background-color: transparent;
overflow: visible;
}
hr {
background-color: #1a1a1a;
border: none;
height: 1px;
margin: 1em 0;
}
table {
margin: 1em 0;
border-collapse: collapse;
width: 100%;
overflow-x: auto;
display: block;
font-variant-numeric: lining-nums tabular-nums;
}
table caption {
margin-bottom: 0.75em;
}
tbody {
margin-top: 0.5em;
border-top: 1px solid #1a1a1a;
border-bottom: 1px solid #1a1a1a;
}
th {
border-top: 1px solid #1a1a1a;
padding: 0.25em 0.5em 0.25em 0.5em;
}
td {
padding: 0.125em 0.5em 0.25em 0.5em;
}
header {
margin-bottom: 4em;
text-align: center;
}
#TOC li {
list-style: none;
}
#TOC ul {
padding-left: 1.3em;
}
#TOC > ul {
padding-left: 0;
}
#TOC a:not(:hover) {
text-decoration: none;
}
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
/* The extra [class] is a hack that increases specificity enough to
override a similar rule in reveal.js */
ul.task-list[class]{list-style: none;}
ul.task-list li input[type="checkbox"] {
font-size: inherit;
width: 0.8em;
margin: 0 0.8em 0.2em -1.6em;
vertical-align: middle;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
]]>
</style><!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
</head>
<body>
<header id="title-block-header">
<h1 class="title">rssc - rss customizer</h1>
</header>
<p>rssc provides a real-time, self-hostable regex-oriented
customization service for atom, rss and json feeds.</p>
<h1 id="usage">Usage</h1>
<p>rssc uses get request parameters to read user's preferences.
following are the supported parameters:</p>
<ul>
<li>
<code>src</code>: the source URL of the feeds. Example:
<a href=
"https://hnrss.org/newest">https://hnrss.org/newest</a>
</li>
<li><code>t</code>: the type of desired feeds (that rssc will
return), can be <code>rss</code>, <code>atom</code> or
<code>json</code>.</li>
<li><code>descriptionf</code>: regular expression filter to
filter feeds based on the description property.</li>
<li><code>titlef</code>: regular expression filter to filter
feeds based on the title property.</li>
<li><code>contentf</code>: regular expression filter to filter
feeds based on the content property.</li>
<li><code>linkf</code>: regular expression filter to filter
feeds based on the link property.</li>
<li><code>net</code>: boolean (1 or 0) (default to 0 when
omitted) whether to use the .NET engine regex instead of
Go's.</li>
</ul>
<p>All regex should be valid <a href=
"https://github.com/google/re2/wiki/Syntax">RE2 regex syntax</a>
(in case of <code>net</code>, see <a href=
"https://learn.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference">
MS' Regular Expression Language</a>).</p>
<h1 id="examples">Examples</h1>
<p>Replace <a href=
"https://rssc.fly.dev/">https://rssc.fly.dev/</a> in the
following examples with your instance of rssc (can be a
<code>localhost:8080</code> if self-hosted).</p>
<ul>
<li>
<p>Get all new feeds that contain the word "emacs" but not
the word "vim", and not posted by user lr0 (hnrss.org does
not provide a creator/author property, so the author filter
here is only for a demonstration purpose.):</p>
<p>
<code>https://rssc.fly.dev/rss?src=https://hnrss.org/newest?q=emacs&titlef=^(?!.*\bvim\b).*\bEmacs\b.*&net=1&authorf=^(?!.*\blr0\b).*$</code></p>
<p>Do note that <code>net</code> is used here because RE2
does not support lookarounds.</p>
</li>
<li>
<p>Get geopolitical updates from your favorite hacker and
skip all free software movement blessed propaganda:</p>
<p>
<code>https://rssc.fly.dev/rss?src=https://stallman.org/rss/rss.xml&contentf=^(?=.*(?:palestine|syria|egypt|iraq|israel|algeria|morocco))(?!.*(?:linux|gnu|software|programming|program)).*$&net=1</code></p>
</li>
<li>
<p>Get BBC middle east updates, only ones that are related to
Palestine:</p>
<p>
<code>https://rssc.fly.dev/rss?src=http://feeds.bbci.co.uk/news/world/middle_east/rss.xml&titlef=(?i)palestine|palestinian|gaza</code></p>
</li>
</ul>
<h1 id="self-host">Self-host</h1>
<p>To host rssc locally, install it using Go:</p>
<pre class=
"shell"><code>go install github.com/larrasket/rssc@latest
</code></pre>
<p>Set environment variable for <code>PORT</code>, if user
doesn't set a <code>PORT</code> value, rssc will use
<code>:8080</code> by default.</p>
<pre class="shell"><code>PORT=4040 rssc
</code></pre>
<p>Now rssc should be running at <code>localhost:4040</code>. You
can use the same <a href="#ex">examples</a> provided, with
replacing fly domain with your localhost.</p>
<h1 id="notes">Notes</h1>
<ul>
<li>RE2 is much safer than the .NET Regex, that's to say, all
the good features that .NET engine enables you to use come with
a risk cost and ends up enabling <a href=
"https://github.com/dlclark/regexp2#catastrophic-backtracking-and-timeouts">
catastrophic backtracking</a>, therefore a timeout of 5
seconds is currently enabled on the fly.dev instance when
using <code>net=1</code>.
</li>
<li>rssc is pre-alpha. Please report bugs <a href=
"mailto:~lr0/[email protected]">here</a> (<a href=
"https://lists.sr.ht/~lr0/public-inbox">url</a>)
</li>
</ul>
</body>
</html>