Command line

Usage

$ rss-funnel [OPTIONS] <SUBCOMMAND>

Options:

• --config/-c: Path to the configuration file. (Required)

Subcommands:

1. Server:

   $ rss-funnel -c <CONFIG_FILE> server [OPTIONS]
   

   • Starts the server with the specified configuration.

   Server Configuration Options:

   • --bind/-b: Address to bind the server to. (Default: 127.0.0.1:4080)
   • --watch/-w: Watch the configuration file and reload on changes.
   • --inspector-ui=false: Disable the inspector UI.

2. Test:

   $ rss-funnel -c <CONFIG_FILE> test [OPTIONS] <ENDPOINT>
   

   • Tests the specified endpoint with the given configuration options.

   Test Configuration Options:

   • --source: Source URL for the endpoint.
   • --limit_filters: Limit the first N filter steps to run.
   • --limit_posts: Limit the number of items in the feed.
   • --quiet: Do not print XML output.

Configuration File

The configuration file is a YAML file containing information about feed definitions and server settings.

Example:

endpoints:
  - path: "/example"
    # ... endpoint configuration ...

Environment

It's often more convenient to specify the server flags via environment than overriding the default command line. This pull request adds the ability to specify the server flags via environment.

Currently, the following environments are supported:

Variable	Default value	Description
RSS_FUNNEL_BIND	127.0.0.1:4080	The server bind address
RSS_FUNNEL_INSPECTOR_UI	true	Whether or not to serve the inspector UI
RSS_FUNNEL_WATCH	false	Whether or not to watch config file change and automatically reload
RSS_FUNNEL_CONFIG	unspecified	The location of the config file.

Note: if you specify the options both from environment and command line, the command line options will take precedence.