Skip to content

Channel

The channel configuration block defines the metadata for your RSS feed.

channel:
url: https://example.com
title: "My Custom Feed"
description: "A feed of the latest news from Example.com"
author: "jane.doe@example.com (Jane Doe)"
ttl: 60
language: "en-us"
time_zone: "Europe/Berlin"
AttributeRequiredDescription
urlRequiredThe URL of the website to scrape.
titleOptionalThe title of the RSS feed. Defaults to the website’s title.
descriptionOptionalA description for the RSS feed. Defaults to the website’s meta description.
authorOptionalThe author of the feed, in the format email (Name).
ttlOptionalThe “time to live” for the feed in minutes. Defaults to the max-age from the response headers, or 360.
languageOptionalThe language of the feed. Defaults to the lang attribute of the <html> tag.
time_zoneOptionalThe time zone for parsing dates. See the list of tz database time zones.

For detailed documentation on the Ruby API, see the official YARD documentation.