9.3 KiB
Executable File
title |
---|
changedetection.io |
linuxserver/changedetection.io
Changedetection.io provides free, open-source web page monitoring, notification and change detection.
Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
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 | ✅ | arm32v7-<version tag> |
Application Setup
Webui is accessible at http://SERVERIP:PORT
Please note that this image does not contain the Playwright content fetcher due to a lack of support for muslc-based systems. If you require this feature please use Selenium or the official container
For more info read the wiki.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
---
version: "2.1"
services:
changedetection:
image: lscr.io/linuxserver/changedetection.io:latest
container_name: changedetection
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- BASE_URL= #optional
volumes:
- /path/to/appdata/config:/config
ports:
- 5000:5000
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=changedetection.io \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e BASE_URL= `#optional` \
-p 5000:5000 \
-v /path/to/appdata/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/changedetection.io:latest
Parameters
Docker images 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 |
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. |
BASE_URL= |
Specify the full URL (including protocol) when running behind a reverse proxy |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
Contains all relevant configuration files. |
Miscellaneous Options
Parameter | Function |
---|
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD
based on the contents of the /run/secrets/mysecretpassword
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 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 user
as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Docker Mods
We publish various 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:
docker exec -it changedetection.io /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f changedetection.io
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' changedetection.io
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/changedetection.io:latest
Versions
- 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.