Skip to content

GrimDevelopment/RssMonitor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RssMonitor

How the Script Works

  1. OPML File Input: The script takes an OPML file as input, which contains a list of RSS feeds you want to monitor.
  2. Database Connection: It connects to the remote database using the configuration specified in the config.json file.
  3. Feed Insertion: The script parses the OPML file and inserts each feed into the database, ensuring that all necessary information is captured.
  4. Monitoring for New Posts: Once the feeds are imported, the RSS Monitor will continuously check for new posts based on the check_interval specified in the configuration. When new content is detected, notifications will be sent to the specified Discord channel.

Usage

To use the import_feeds.sh script, follow these steps:

  1. Ensure that your OPML file is ready and accessible.

  2. Open a terminal and navigate to the directory containing the import_feeds.sh script.

  3. Run the script with the following command:

./import_feeds.sh path/to/your/feeds.opml
  1. The script will process the OPML file and import the feeds into your database.

Configuration Details

Database Configuration:


host: The IP address or hostname of your database server.

user: The username for accessing the database.

password: The password for the database user.

database: The name of the database to connect to.

Discord Configuration:


webhook_url: The URL for the Discord webhook where notifications will be sent.

author: Information about the author of the notifications.

name: The name displayed as the author.

url: The URL associated with the author.

icon_url: The icon displayed next to the author's name.

footer: Information for the footer of the notification.

text: The text displayed in the footer.

icon_url: The icon displayed in the footer.

Feed Settings:


notification_cooldown: Time (in seconds) to wait before sending another notification for the same feed.

check_interval - Time (in seconds) between checks for new content.

error_threshold - Number of consecutive errors before the feed is considered down.

retry_interval - Time (in seconds) to wait before retrying a failed feed check.

Feed Scheduling:


min_check_interval: Minimum time (in seconds) between feed checks.

max_check_interval: Maximum time (in seconds) between feed checks.

performance_weight: A weight factor to influence the scheduling of feed checks based on performance.

Notification Defaults:


title_keywords: An array of keywords to look for in the titles of new posts.

description: The default description for notifications.

color: The color of the notification in hexadecimal format.

timestamp: A boolean indicating whether to include a timestamp in the notification.

fields: An array of additional fields to include in the notification.

Make sure to replace the placeholders with your specific details to ensure the RSS Monitor operates correctly. If you have any questions or need further assistance, feel free to reach out!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors