Added docs

This commit is contained in:
Niels Bouma 2023-08-01 16:27:28 +02:00
parent 0e8d7eb0e3
commit 906254f5ea
2 changed files with 55 additions and 0 deletions

View file

@ -0,0 +1,54 @@
# Changedetection.io
[Changedetection.io](https://github.com/dgtlmoon/changedetection.io) is simple **website change detection and restock monitoring** solution.
## Dependencies
This service requires the following other services:
- a [Traefik](traefik.md) reverse-proxy server
## Configuration
To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
```yaml
########################################################################
# #
# Changedetection.io #
# #
########################################################################
changedetection_enabled: true
changedetection_hostname: mash.example.com
changedetection_path_prefix: /changedetection
########################################################################
# #
# /Changedetection.io #
# #
########################################################################
```
### Playwright webdriver
Some advanced options like using javascript or using the Visual Selector tool use an additional playwright webdriver. To enable this driver, add the following **additional** configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
```yaml
changedetection_playwright_driver_enabled: true
```
### URL
In the example configuration above, we configure the service to be hosted at `https://mash.example.com/changedetection`.
You can remove the `changedetection_path_prefix` variable definition, to make it default to `/`, so that the service is served at `https://mash.example.com/`.
## Usage
After installation, you can go to your given URL and start setting up Changedetection.io

View file

@ -6,6 +6,7 @@
| [AdGuard Home](https://adguard.com/en/adguard-home/overview.html/) | A network-wide DNS software for blocking ads & tracking | [Link](services/adguard-home.md) |
| [Appsmith](https://www.appsmith.com/) | Platform for building and deploying custom internal tools and applications without writing code | [Link](services/appsmith.md) |
| [authentik](https://goauthentik.io/) | An open-source Identity Provider focused on flexibility and versatility. | [Link](services/authentik.md) |
| [Changedetection.io](https://github.com/dgtlmoon/changedetection.io) | A simple website change detection and restock monitoring solution. | [Link](services/changedetection.md) |
| [ClickHouse](https://clickhouse.com/) | An open-source column-oriented DBMS for online analytical processing (OLAP) that allows users to generate analytical reports using SQL queries in real-time. | [Link](services/clickhouse.md) |
| [Collabora Online](https://www.collaboraoffice.com/) | Your Private Office Suite In The Cloud | [Link](services/collabora-online.md) |
| [Docker](https://www.docker.com/) | Open-source software for deploying containerized applications | [Link](services/docker.md) |