{"id":20969348,"url":"https://github.com/imranr98/logtfy","last_synced_at":"2025-07-04T08:04:12.957Z","repository":{"id":249458748,"uuid":"831573214","full_name":"ImranR98/Logtfy","owner":"ImranR98","description":"Simple log monitoring service that uses ntfy for alerts.","archived":false,"fork":false,"pushed_at":"2024-12-04T00:01:25.000Z","size":63,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-04T08:03:40.483Z","etag":null,"topics":["alerting","alerting-service","alerts","logging","logs","monitoring","monitoring-automation","ntfy","ntfy-sh"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ImranR98.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-07-21T01:01:20.000Z","updated_at":"2025-03-02T10:40:40.000Z","dependencies_parsed_at":"2024-08-03T01:57:33.921Z","dependency_job_id":"69c14ba7-4eca-492c-94fb-f44d7fc08b41","html_url":"https://github.com/ImranR98/Logtfy","commit_stats":null,"previous_names":["imranr98/logtfy"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ImranR98/Logtfy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImranR98%2FLogtfy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImranR98%2FLogtfy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImranR98%2FLogtfy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImranR98%2FLogtfy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ImranR98","download_url":"https://codeload.github.com/ImranR98/Logtfy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImranR98%2FLogtfy/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263472277,"owners_count":23471811,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alerting","alerting-service","alerts","logging","logs","monitoring","monitoring-automation","ntfy","ntfy-sh"],"created_at":"2024-11-19T03:20:20.692Z","updated_at":"2025-07-04T08:04:12.934Z","avatar_url":"https://github.com/ImranR98.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Logtfy\n\nSimple log monitoring service that uses [ntfy](https://ntfy.sh) for alerts.\n\n## Details\n\n- Logs from a specified source are continuously monitored, parsed, and used to trigger alerts that are posted to a ntfy topic.\n- This is done through packages called modules - each module represents a specific source of logs.\n  - For example, the `ssh_logins` module is used to monitor SSH logs and send an alert when someone logs in via SSH.\n  - Modules are stored in the `modules` directory and each module must contain these 2 files:\n    - `logger.sh`: Defines the log message source (continuously outputs log messages).\n    - `parser.sh`: Parses an individual log and decides whether it should trigger a ntfy alert (if so, this script print a specifically formatted output containing the final alert data).\n- Alerts can be sent to a user-defined ntfy server/topic, with the option to fallback to a second server/topic in case of failure.\n\n# Usage\n\n1. Create a copy of `config.default.json` and name it `config.json`.\n2. Modify `config.json` to suit your needs.\n   - This file defines your `ntfy.sh` servers (server URL, credentials, and an optional prefix to append to all topic names).\n     - You can define as many servers as you want, but only 1 to 2 are used (the main server, with an optional fallback).\n   - This file also defines changes to the default settings per module.\n     - This includes specifying a different ntfy server (and fallback) to use, customizing the topic name, disabling modules, and adding additional data to use for log collection and parsing.\n   - Other details not mentioned - most property names are self-explanatory.\n3. Optionally, create a copy of `onExit.default.sh` named `onExit.sh` and customize it - this file runs when the monitoring script exits for any reason. By default, it will attempt to send a ntfy alert to your configured server.\n4. If you've enabled a module that grabs logs from a Kubernetes service, you'll need to run `k8s/prep.sh`.\n5. Launch the service with `run.sh`\n   - Alternatively, you can use the `Dockerfile` to build and run a Docker image.\n   - You can also set it up to run as a systemd service using the example service config file `logtfy.service.example`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimranr98%2Flogtfy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimranr98%2Flogtfy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimranr98%2Flogtfy/lists"}