Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.65 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.65 KB

Overview

Feedscraper is an automatic webscraper and RSS generater.

Install and run with

$ cargo install --git https://github.com/siriusmart/feedscraper
$ feedscraper

By default, going to http://localhost:8080 should present you with a navigatable UI of hyperlinks. You can use my personal instance at https://feeds.siri.sh (powered by rpi w/ debian) if you dont have the hardware to host your own.

Configuration

Config files can be found in ~/.config/feedscraper (Linux), /Users/[Username]/Library/Application/Support/feedscraper (Mac) or C:\Users\[Username]\AppData\Roaming\feedscraper (Windows).

feedscraper.json is the server's main config file, here are all the available options.

{
    "http_port": Number?,
    "https": {
        port: Number,
        chain: String, // path to ssl chain, e.g. /etc/letsencrypt/live/yourdomain.com/fullchain.pem
        key: String // path to ssl privkey, e.g. /etc/letsencrypt/live/yourdomain.com/privkey.pem
    }?,
    "show_feed_configs": Boolean,
    "description": String, // html string, it is unsanitised and may include css links and etc
    "splash": Boolean, // show default message
    "version": Boolean, // show version in homepage
}

http_port and https are optional fields, removing the option will disable the corresponding protocol. show_feed_configs when set to false, hides content in feeds.json, useful if it includes private information such as API tokens.

scrapyard.json and feeds.json use the same specs as in scrapyard, which is the base crate of this server.

License: AGPL-3.0 (The happy Stallman license)