You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
184 lines
7.8 KiB
184 lines
7.8 KiB
# changedetection.io
|
|
[![Release Version][release-shield]][release-link] [![Docker Pulls][docker-pulls]][docker-link] [![License][license-shield]](LICENSE.md)
|
|
|
|
|
|
|
|
## 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.
|
|
|
|
|
|
<img src="https://raw.githubusercontent.com/dgtlmoon/changedetection.io/master/screenshot.png" style="max-width:100%;" alt="Self-hosted web page change monitoring" title="Self-hosted web page change monitoring" />
|
|
|
|
[](https://dashboard.heroku.com/new?template=https%3A%2F%2Fgithub.com%2Fdgtlmoon%2Fchangedetection.io%2Ftree%2Fmaster)
|
|
|
|
#### Example use cases
|
|
|
|
Know when ...
|
|
- Products and services have a change in pricing
|
|
- Governmental department updates (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
|
|
- Trigger API calls via notifications when text appears on a website
|
|
- Glue together APIs using the JSON filter and JSON notifications
|
|
- Create RSS feeds based on changes in web content
|
|
|
|
_Need an actual Chrome runner with Javascript support? We support fetching via WebDriver!</a>_
|
|
|
|
**Get monitoring now! super simple.**
|
|
|
|
<a href="https://dashboard.heroku.com/new?template=https%3A%2F%2Fgithub.com%2Fdgtlmoon%2Fchangedetection.io%2Ftree%2Fmaster">Deploy to Heroku for free</a>, Run this python directly, or with <a href="https://docs.docker.com/get-docker/">docker</a> and/or <a href="https://www.digitalocean.com/community/tutorial_collections/how-to-install-docker-compose">docker-compose</a>
|
|
|
|
## Screenshots
|
|
|
|
Examining differences in content.
|
|
|
|
<img src="https://raw.githubusercontent.com/dgtlmoon/changedetection.io/master/screenshot-diff.png" style="max-width:100%;" alt="Self-hosted web page change monitoring context difference " title="Self-hosted web page change monitoring context difference " />
|
|
|
|
Please :star: star :star: this project and help it grow! https://github.com/dgtlmoon/changedetection.io/
|
|
|
|
|
|
## Installation
|
|
|
|
### Docker
|
|
|
|
With Docker composer, just clone this repository and..
|
|
```bash
|
|
$ docker-compose up -d
|
|
```
|
|
Docker standalone
|
|
```bash
|
|
$ 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/
|
|
|
|
```bash
|
|
$ 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
|
|
|
|
```bash
|
|
docker-compose pull && docker-compose up -d
|
|
```
|
|
|
|
### 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 <a href="https://github.com/caronc/apprise">apprise</a> 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://
|
|
|
|
<a href="https://github.com/caronc/apprise#popular-notification-services">And everything else in this list!</a>
|
|
|
|
<img src="https://raw.githubusercontent.com/dgtlmoon/changedetection.io/master/screenshot-notifications.png" style="max-width:100%;" alt="Self-hosted web page change monitoring notifications" title="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.
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
#### 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 <a href="https://github.com/dgtlmoon/changedetection.io/blob/master/docker-compose.yml">docker-compose.yml</a>.
|
|
|
|
For more information see https://docs.python-requests.org/en/master/user/advanced/#proxies
|
|
|
|
This proxy support also extends to the notifications https://github.com/caronc/apprise/issues/387#issuecomment-841718867
|
|
|
|
### 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`
|
|
|
|
<img src="https://raw.githubusercontent.com/dgtlmoon/changedetection.io/master/btc-support.png" style="max-width:50%;" alt="Support us!" />
|
|
|
|
|
|
[release-shield]: https://img.shields.io/github/v/release/dgtlmoon/changedetection.io?style=for-the-badge
|
|
[docker-pulls]: https://img.shields.io/docker/pulls/dgtlmoon/changedetection.io?style=for-the-badge
|
|
[test-shield]: https://github.com/dgtlmoon/changedetection.io/actions/workflows/test-only.yml/badge.svg?branch=master
|
|
|
|
[license-shield]: https://img.shields.io/github/license/dgtlmoon/changedetection.io.svg?style=for-the-badge
|
|
[release-link]: https://github.com/dgtlmoon.com/changedetection.io/releases
|
|
[docker-link]: https://hub.docker.com/r/dgtlmoon/changedetection.io
|