Service: ChangeDetection IO - EyevinnOSC/community GitHub Wiki

changedetection.io

changedetection.io (serviceId dgtlmoon-changedetectionio) watches web pages and APIs for changes and alerts you when something updates. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 5 GiB of storage per instance. License: Apache-2.0.

What it can do

  • Watch a product page, a notice, a PDF or a JSON endpoint and check it at an interval you choose.
  • Focus on the content you care about with selectors and filters: XPath, CSS, JSONPath, jq, regex, ignore and extract rules.
  • Show diffs at word, line or character level when a change is detected.
  • Send conditional notifications (keywords, thresholds such as price bounds) through channels supported by Apprise, for example email, Discord, Slack, Telegram and webhooks.
  • Be managed through the web UI or its REST API.

Creating an instance

The service has no dependencies on other OSC services. Always set a password; without one anyone with the URL can use the UI.

  1. Store the password with create-service-secret (serviceId dgtlmoon-changedetectionio, for example name cdpassword).
  2. Create the instance with create-service-instance, serviceId: "dgtlmoon-changedetectionio":
{ "name": "mywatcher", "AdminPassword": "{{secrets.cdpassword}}", "Timezone": "Europe/Stockholm", "LoggerLevel": "INFO" }
  1. Wait for it to be running (wait-for-service-ready or get-instance-status) and get the URL with describe-service-instance.

The login page asks for a password only. There is no username and no default password: use the value stored in the secret.

Options

Option Required Type Meaning
name Yes string Name of the instance. Letters, digits and underscore only (^\w+$), at most 20 characters.
AdminPassword Yes string, sensitive Password for the web UI login. At startup the OSC entrypoint hashes it (PBKDF2-SHA256) into SALTED_PASS and does not keep the plain value. Feeds ADMIN_PASSWORD.
FetchWorkers No string (whole number) Number of pages fetched in parallel (FETCH_WORKERS). Default 5 when empty; lower values use less memory.
PageWatchLimit No string (whole number) Maximum total number of watches (PAGE_WATCH_LIMIT), enforced in the UI, imports and the API. Empty or non-numeric means unlimited.
DisableVersionCheck No boolean true stops the app checking for new upstream releases (DISABLE_VERSION_CHECK). Off by default.
Timezone No string Default timezone as an IANA name, for example Europe/Stockholm (TZ). Used for watch schedules and date/time expressions in notifications. Default UTC.
LoggerLevel No string Log verbosity (LOGGER_LEVEL), for example INFO or WARNING, case-insensitive. Empty logs at DEBUG, which is very verbose, so INFO is recommended.

Store AdminPassword as a service secret and pass it as {{secrets.NAME}} (whole field value only). Overwriting a secret does not restart a running instance.

Using the instance

Open the instance URL and log in. Paste the URL of the page to monitor into the field at the top and click Watch. Open the watch to set the check interval, add filters and configure notifications.

With the OSC CLI:

osc create dgtlmoon-changedetectionio mywatcher \
  -o AdminPassword="{{secrets.cdpassword}}" \
  -o Timezone="Europe/Stockholm" \
  -o LoggerLevel="INFO"

Limitations

  • Storage is limited to 5 GiB per instance.

Resources