rssc

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 24 Open GitHub ↗

rssc provides a real-time, self-hostable regex-oriented customization service for atom, rss and json feeds.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

rssc provides a real-time, self-hostable regex-oriented customization service for atom,
rss and json feeds.

# Usage

rssc uses get request parameters to read user&rsquo;s preferences. following are the
supported parameters:

-   `src`: the source URL of the feeds. Example: <https://hnrss.org/newest>
-   `t`: the type of desired feeds (that rssc will return), can be `rss`, `atom` or `json`.
-   `descriptionf`: regular expression filter to filter feeds based on the description property.
-   `titlef`: regular expression filter to filter feeds based on the title property.
-   `contentf`: regular expression filter to filter feeds based on the content property.
-   `linkf`: regular expression filter to filter feeds based on the link property.
-   `net`: boolean (1 or 0) (default to 0 when omitted) whether to use the .NET
    engine regex instead of Go&rsquo;s.

All regex should be valid [RE2 regex syntax](https://github.com/google/re2/wiki/Syntax) (in case of `net`, see [MS&rsquo; Regular Expression Language](https://learn.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference)).

# Examples

Replace <https://rssc.fly.dev/> in the following examples with your instance of
rssc (can be a `localhost:8080` if self-hosted).

-   Get all new feeds that contain the word &ldquo;emacs&rdquo; but not the word &ldquo;vim&rdquo;, 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.):
    
    [https://rssc.fly.dev/rss?src=https://hnrss.org/newest?q=emacs&titlef=^(?!.\*\bvim\b).\*\bEmacs\b.\*&net=1&authorf=^(?!.\*\blr0\b).\*$](https://rssc.fly.dev/rss?src=https://hnrss.org/newest?q=emacs&titlef=^(?!.*\bvim\b).*\bEmacs\b.*&net=1&authorf=^(?!.*\blr0\b).*$)
    
    Do note that `net` is used here because RE2 does not support lookarounds.

# Self-host

To host rssc locally, install it using Go:

go install github.com/larrasket/rssc@latest

Set environment variable for `PORT`, if user doesn&rsquo;t set a `PORT` value, rssc will use `:8080` by default.

PORT=4040 rssc

Now rssc should be running at `localhost:4040`. You can use the same [examples](#ex)
provided, with replacing fly domain with your localhost.

# Notes

-   RE2 is much safer than the .NET Regex, that&rsquo;s to say, all the good features
    that .NET engine enables you to use come with a risk cost and ends up
    enabling [catastrophic backtracking](https://github.com/dlclark/regexp2#catastrophic-backtracking-and-timeouts), therefore a timeout of 5 seconds is currently
    enabled on the fly.dev instance when using `net=1`.
-   rssc is pre-alpha. Please report bugs [here](mailto:~lr0/public-inbox@lists.sr.ht) ([url](https://lists.sr.ht/~lr0/public-inbox))

rssc

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README