Skip to content

Latest commit

 

History

History
178 lines (114 loc) · 7.42 KB

README.md

File metadata and controls

178 lines (114 loc) · 7.42 KB

changedetection.io

changedetection.io Docker Pulls Change detection latest tag version

Self-hosted open source change monitoring of web pages.

Know when web pages change! Stay ontop of new information!

Live your data-life pro-actively instead of re-actively, do not rely on manipulative social media for consuming important information.

Open source web page monitoring, notification and change detection.

Self-hosted web page change monitoring

Deploy

Example use cases

Know when ...

  • Government department updates (changes are often only on their websites)
  • Local government news (changes are often only on their websites)
  • New software releases, security advisories when you're not on their mailing list.
  • Festivals with changes
  • Realestate listing changes
  • COVID related news from government websites
  • Detect and monitor changes in JSON API responses
  • API monitoring and alerting

Need an actual Chrome runner with Javascript support? We support fetching via WebDriver!

Get monitoring now! super simple, one command!

Run the python code on your own machine by cloning this repository, or with docker and/or docker-compose

Installation

Docker

Note: We also use GitHub's container repository, because DockerHub has limited pull/downloads.

With Docker composer, just clone this repository and..

$ docker-compose up -d

Docker standalone

$ docker run -d --restart always -p "127.0.0.1:5000:5000" -v datastore-volume:/datastore --name changedetection.io dgtlmoon/changedetection.io

Python Pip

Check out our pypi page https://pypi.org/project/changedetection.io/

$ pip3 install changedetection.io
$ changedetection.io -d /path/to/empty/data/dir -p 5000

Then visit http://127.0.0.1:5000 , You should now be able to access the UI.

Now with per-site configurable support for using a fast built in HTTP fetcher or use a Chrome based fetcher for monitoring of JavaScript websites!

Updating changedetection.io

Docker

docker pull dgtlmoon/changedetection.io
docker kill $(docker ps -a|grep changedetection.io|awk '{print $1}')
docker rm $(docker ps -a|grep changedetection.io|awk '{print $1}')
docker run -d --restart always -p "127.0.0.1:5000:5000" -v datastore-volume:/datastore --name changedetection.io dgtlmoon/changedetection.io

docker-compose

docker-compose pull && docker-compose up -d

Screenshots

Examining differences in content.

Self-hosted web page change monitoring context difference

Please ⭐ star ⭐ this project and help it grow! https://github.com/dgtlmoon/changedetection.io/

Notifications

ChangeDetection.io supports a massive amount of notifications (including email, office365, custom APIs, etc) when a web-page has a change detected thanks to the apprise library. Simply set one or more notification URL's in the [edit] tab of that watch.

Just some examples

discord://webhook_id/webhook_token
flock://app_token/g:channel_id
gitter://token/room
gchat://workspace/key/token
msteams://TokenA/TokenB/TokenC/
o365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail
rocket://user:password@hostname/#Channel
mailto://user:pass@example.com?to=receivingAddress@example.com
json://someserver.com/custom-api
syslog://

And everything else in this list!

Self-hosted web page change monitoring notifications

Now you can also customise your notification content!

JSON API Monitoring

Detect changes and monitor data in JSON API's by using the built-in JSONPath selectors as a filter / selector.

image

This will re-parse the JSON and apply formatting to the text, making it super easy to monitor and detect changes in JSON API results

image

Parse JSON embedded in HTML!

When you enable a json: filter, you can even automatically extract and parse embedded JSON inside a HTML page! Amazingly handy for sites that build content based on JSON, such as many e-commerce websites.

<html>
...
<script type="application/ld+json">
  {"@context":"http://schema.org","@type":"Product","name":"Nan Optipro Stage 1 Baby Formula  800g","price": 23.50 }
</script>

json:$.price would give 23.50, or you can extract the whole structure

Proxy

A proxy for ChangeDetection.io can be configured by setting environment the HTTP_PROXY, HTTPS_PROXY variables, examples are also in the docker-compose.yml

NO_PROXY exclude list can be specified by following "localhost,192.168.0.0/24"

as docker run with -e

docker run -d --restart always -e HTTPS_PROXY="socks5h://10.10.1.10:1080" -p "127.0.0.1:5000:5000" -v datastore-volume:/datastore --name changedetection.io dgtlmoon/changedetection.io

With docker-compose, see the Proxy support example in docker-compose.yml.

For more information see https://docs.python-requests.org/en/master/user/advanced/#proxies

This proxy support also extends to the notifications caronc/apprise#387 (comment)

RaspberriPi support?

RaspberriPi and linux/arm/v6 linux/arm/v7 arm64 devices are supported!

Windows native support?

Sorry not yet :( https://github.com/dgtlmoon/changedetection.io/labels/windows

Support us

Do you use changedetection.io to make money? does it save you time or money? Does it make your life easier? less stressful? Remember, we write this software when we should be doing actual paid work, we have to buy food and pay rent just like you.

Please support us, even small amounts help a LOT.

BTC 1PLFN327GyUarpJd7nVe7Reqg9qHx5frNn

Support us!