Checkcle
checkcle A monitoring platform for real-time full-stack systems, applications, and infrastructure.
Announcement and talks
The checkcle app announcement here
Sources
checkcle is a community application from the repository. Documentation and source can be found on
Please see the excerpt from the readme below.
- README.md
## Installation Instantiate the module with the following command: ```bash add-module ghcr.io/geniusdynamics/checkcle:latest 1 ``` The output will return the instance name, for example: ```json { "module_id": "checkcle1", "image_name": "checkcle", "image_url": "ghcr.io/geniusdynamics/checkcle:latest" } ``` ## Configuration Assuming the instance is named `checkcle1`, launch `configure-module` with the following parameters: - `host`: Fully qualified domain name for the application - `http2https`: Enable or disable HTTP to HTTPS redirection (true/false) - `lets_encrypt`: Enable or disable Let's Encrypt certificate (true/false) Example configuration: ```bash api-cli run configure-module --agent module/checkcle1 --data - <<EOF { "host": "checkcle.domain.com", "http2https": true, "lets_encrypt": false } EOF ``` This command will: - Start and configure the checkcle instance - Configure a virtual host for Traefik to access the instance ## Usage ### Get Configuration Retrieve the current configuration: ```bash api-cli run get-configuration --agent module/checkcle1 ``` ### Update Module To update the module to a new version or image, use the following command: ```bash api-cli run update-module --data '{ "module_url": "ghcr.io/geniusdynamics/checkcle:latest", "instances": ["checkcle1"], "force": true }' ``` This will update the specified instances to the new module URL. ## Uninstallation To uninstall the instance: ```bash remove-module --no-preserve checkcle1 ```
