Git Product home page Git Product logo

website-watcher's Introduction

Website Watcher

A simple script that uses Github Actions and ntfy.sh to periodically poll websites and notify you of changes in the HTML.

Get started

  1. Fork this repository.

  2. Go to the repo's settings > Actions > Workflow permissions and set to Read and write permissions.

  3. Set your ntfy.sh topic name as a repository secret with name the NTFY_TOPIC.

  4. Edit .github/workflows/poll-websites line 6 with the cron schedule expression of your preference. Default is "0 6 * * *" (daily at 6 am).

  5. Edit watch.json.

watch.json

You can specify which websites to poll and under what conditions the script should notify you in watch.json.

The file consists of a list of key-value pairs. You specify the name of each website / notification as the key of an entry. This is the name that will appear in notifications. The value of each key must be another object and contain at least:

  • "url": the url to monitor (with GET requests)
  • "on": the criteria that will trigger a notification. "in" will notify if the text in "txt" is in the retried HTML, "not_in" the opposite, and "change" will do so if the page changes from a cached version.

You must include a "txt" field if "on" is either "in" or "not_in".

Note: "change" will automatically cache the page the first time the script is ran and will overwrites cached version when a change is detected.

website-watcher's People

Contributors

emiliocantuc avatar github-actions[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.