kopia lustrzana https://github.com/linuxserver/docker-documentation
353 wiersze
14 KiB
Markdown
Executable File
353 wiersze
14 KiB
Markdown
Executable File
---
|
|
title: changedetection.io
|
|
tags:
|
|
- Web Tools
|
|
- Automation
|
|
description: "[Changedetection.io](https://github.com/dgtlmoon/changedetection.io) provides free, open-source web page monitoring, notification and change detection."
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read https://github.com/linuxserver/docker-changedetection.io/blob/main/.github/CONTRIBUTING.md -->
|
|
# [linuxserver/changedetection.io](https://github.com/linuxserver/docker-changedetection.io)
|
|
|
|
[](https://scarf.sh)
|
|
[](https://github.com/linuxserver/docker-changedetection.io)
|
|
[](https://github.com/linuxserver/docker-changedetection.io/releases)
|
|
[](https://github.com/linuxserver/docker-changedetection.io/packages)
|
|
[](https://gitlab.com/linuxserver.io/docker-changedetection.io/container_registry)
|
|
[](https://quay.io/repository/linuxserver.io/changedetection.io)
|
|
[](https://hub.docker.com/r/linuxserver/changedetection.io)
|
|
[](https://hub.docker.com/r/linuxserver/changedetection.io)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-changedetection.io/job/main/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/changedetection.io/latest/index.html)
|
|
|
|
[Changedetection.io](https://github.com/dgtlmoon/changedetection.io) provides free, open-source web page monitoring, notification and change detection.
|
|
|
|
[](https://github.com/dgtlmoon/changedetection.io)
|
|
|
|
## Supported Architectures
|
|
|
|
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
|
|
|
Simply pulling `lscr.io/linuxserver/changedetection.io:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
|
|
|
The architectures supported by this image are:
|
|
|
|
| Architecture | Available | Tag |
|
|
| :----: | :----: | ---- |
|
|
| x86-64 | ✅ | amd64-\<version tag\> |
|
|
| arm64 | ✅ | arm64v8-\<version tag\> |
|
|
| armhf | ❌ | |
|
|
|
|
## Application Setup
|
|
|
|
Webui is accessible at http://SERVERIP:PORT
|
|
|
|
Please note that as of version 0.45.16 this image contains the Playwright content fetcher.
|
|
|
|
For more info read [the wiki](https://github.com/dgtlmoon/changedetection.io/wiki).
|
|
|
|
## Read-Only Operation
|
|
|
|
This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/).
|
|
|
|
## Non-Root Operation
|
|
|
|
This image can be run with a non-root user. For details please [read the docs](https://docs.linuxserver.io/misc/non-root/).
|
|
|
|
## Usage
|
|
|
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
|
|
|
!!! info
|
|
|
|
Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
|
|
|
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
|
|
|
```yaml
|
|
---
|
|
services:
|
|
changedetection:
|
|
image: lscr.io/linuxserver/changedetection.io:latest
|
|
container_name: changedetection
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=Etc/UTC
|
|
- BASE_URL= #optional
|
|
- PLAYWRIGHT_DRIVER_URL= #optional
|
|
volumes:
|
|
- /path/to/changedetection/config:/config
|
|
ports:
|
|
- 5000:5000
|
|
restart: unless-stopped
|
|
```
|
|
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name=changedetection.io \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=Etc/UTC \
|
|
-e BASE_URL= `#optional` \
|
|
-e PLAYWRIGHT_DRIVER_URL= `#optional` \
|
|
-p 5000:5000 \
|
|
-v /path/to/changedetection.io/config:/config \
|
|
--restart unless-stopped \
|
|
lscr.io/linuxserver/changedetection.io:latest
|
|
```
|
|
|
|
## Parameters
|
|
|
|
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
|
|
|
### Ports (`-p`)
|
|
|
|
| Parameter | Function |
|
|
| :----: | --- |
|
|
| `5000:5000` | WebUI |
|
|
|
|
### Environment Variables (`-e`)
|
|
|
|
| Env | Function |
|
|
| :----: | --- |
|
|
| `PUID=1000` | for UserID - see below for explanation |
|
|
| `PGID=1000` | for GroupID - see below for explanation |
|
|
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
|
|
| `BASE_URL=` | Specify the full URL (including protocol) when running behind a reverse proxy |
|
|
| `PLAYWRIGHT_DRIVER_URL=` | Specify the full URL to your chrome driver instance. See the [wiki](https://github.com/dgtlmoon/changedetection.io/wiki/Playwright-content-fetcher) for details. |
|
|
|
|
### Volume Mappings (`-v`)
|
|
|
|
| Volume | Function |
|
|
| :----: | --- |
|
|
| `/config` | Persistent config files |
|
|
|
|
#### Miscellaneous Options
|
|
|
|
| Parameter | Function |
|
|
| :-----: | --- |
|
|
| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |
|
|
| `--user=1000:1000` | Run container with a non-root user. Please [read the docs](https://docs.linuxserver.io/misc/non-root/). |
|
|
|
|
## Environment variables from files (Docker secrets)
|
|
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
|
|
|
As an example:
|
|
|
|
```bash
|
|
-e FILE__MYVAR=/run/secrets/mysecretvariable
|
|
```
|
|
|
|
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
|
|
|
|
## Umask for running applications
|
|
|
|
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
|
|
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
|
|
|
## User / Group Identifiers
|
|
|
|
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
|
|
|
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
|
|
|
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
|
|
|
|
```bash
|
|
id your_user
|
|
```
|
|
|
|
Example output:
|
|
|
|
```text
|
|
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
|
|
```
|
|
|
|
## Docker Mods
|
|
|
|
[](https://mods.linuxserver.io/?mod=changedetection.io "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
|
|
|
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
|
|
|
|
## Support Info
|
|
|
|
* Shell access whilst the container is running:
|
|
|
|
```bash
|
|
docker exec -it changedetection.io /bin/bash
|
|
```
|
|
|
|
* To monitor the logs of the container in realtime:
|
|
|
|
```bash
|
|
docker logs -f changedetection.io
|
|
```
|
|
|
|
* Container version number:
|
|
|
|
```bash
|
|
docker inspect -f '{{ index .Config.Labels "build_version" }}' changedetection.io
|
|
```
|
|
|
|
* Image version number:
|
|
|
|
```bash
|
|
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/changedetection.io:latest
|
|
```
|
|
|
|
## Updating Info
|
|
|
|
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
|
|
|
|
Below are the instructions for updating containers:
|
|
|
|
### Via Docker Compose
|
|
|
|
* Update images:
|
|
* All images:
|
|
|
|
```bash
|
|
docker-compose pull
|
|
```
|
|
|
|
* Single image:
|
|
|
|
```bash
|
|
docker-compose pull changedetection.io
|
|
```
|
|
|
|
* Update containers:
|
|
* All containers:
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
* Single container:
|
|
|
|
```bash
|
|
docker-compose up -d changedetection.io
|
|
```
|
|
|
|
* You can also remove the old dangling images:
|
|
|
|
```bash
|
|
docker image prune
|
|
```
|
|
|
|
### Via Docker Run
|
|
|
|
* Update the image:
|
|
|
|
```bash
|
|
docker pull lscr.io/linuxserver/changedetection.io:latest
|
|
```
|
|
|
|
* Stop the running container:
|
|
|
|
```bash
|
|
docker stop changedetection.io
|
|
```
|
|
|
|
* Delete the container:
|
|
|
|
```bash
|
|
docker rm changedetection.io
|
|
```
|
|
|
|
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
|
* You can also remove the old dangling images:
|
|
|
|
```bash
|
|
docker image prune
|
|
```
|
|
|
|
### Image Update Notifications - Diun (Docker Image Update Notifier)
|
|
|
|
!!! tip
|
|
|
|
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
|
|
|
|
## Building locally
|
|
|
|
If you want to make local modifications to these images for development purposes or just to customize the logic:
|
|
|
|
```bash
|
|
git clone https://github.com/linuxserver/docker-changedetection.io.git
|
|
cd docker-changedetection.io
|
|
docker build \
|
|
--no-cache \
|
|
--pull \
|
|
-t lscr.io/linuxserver/changedetection.io:latest .
|
|
```
|
|
|
|
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
|
|
|
|
```bash
|
|
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
|
|
```
|
|
|
|
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
|
|
|
|
To help with development, we generate this dependency graph.
|
|
|
|
??? info "Init dependency graph"
|
|
|
|
```d2
|
|
"changedetection.io:latest": {
|
|
docker-mods
|
|
base {
|
|
fix-attr +\nlegacy cont-init
|
|
}
|
|
docker-mods -> base
|
|
legacy-services
|
|
custom services
|
|
init-services -> legacy-services
|
|
init-services -> custom services
|
|
custom services -> legacy-services
|
|
legacy-services -> ci-service-check
|
|
init-migrations -> init-adduser
|
|
init-config -> init-changedetection-config
|
|
init-os-end -> init-config
|
|
init-changedetection-config -> init-config-end
|
|
init-config -> init-config-end
|
|
init-crontab-config -> init-config-end
|
|
init-config -> init-crontab-config
|
|
init-mods-end -> init-custom-files
|
|
base -> init-envfile
|
|
base -> init-migrations
|
|
init-config-end -> init-mods
|
|
init-mods-package-install -> init-mods-end
|
|
init-mods -> init-mods-package-install
|
|
init-adduser -> init-os-end
|
|
init-envfile -> init-os-end
|
|
init-custom-files -> init-services
|
|
init-services -> svc-changedetection
|
|
svc-changedetection -> legacy-services
|
|
init-services -> svc-cron
|
|
svc-cron -> legacy-services
|
|
}
|
|
Base Images: {
|
|
"baseimage-alpine:3.21"
|
|
}
|
|
"changedetection.io:latest" <- Base Images
|
|
```
|
|
|
|
## Versions
|
|
|
|
* **19.12.24:** - Rebase to Alpine 3.21.
|
|
* **31.05.24:** - Rebase to Alpine 3.20.
|
|
* **09.03.24:** - Build Playwright from source because Microsoft's build and packaging process is awful.
|
|
* **08.03.24:** - Build Playwright-python from source, add libjpeg.
|
|
* **23.12.23:** - Rebase to Alpine 3.19.
|
|
* **10.08.23:** - Add poppler-utils for pdf conversion tools.
|
|
* **11.06.23:** - Rebase to Alpine 3.18, deprecate armhf.
|
|
* **05.03.23:** - Rebase to Alpine 3.17.
|
|
* **23.10.22:** - Rebase to Alpine 3.16, migrate to s6v3.
|
|
* **09.10.22:** - Add make as build dep to fix pip jq build on armhf.
|
|
* **07.08.22:** - Initial release.
|