{"id":15489703,"url":"https://github.com/pablopunk/doctorz","last_synced_at":"2025-03-28T16:25:52.986Z","repository":{"id":197309056,"uuid":"698412996","full_name":"pablopunk/doctorz","owner":"pablopunk","description":"Monitors ZFS Pools with `zpool status` and sends you an email if the pool has been degraded.","archived":false,"fork":false,"pushed_at":"2023-11-26T11:13:59.000Z","size":1864,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-19T08:58:41.754Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://registry.hub.docker.com/r/pablopunk/doctorz","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pablopunk.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-09-29T21:28:51.000Z","updated_at":"2024-08-03T17:57:31.000Z","dependencies_parsed_at":"2023-11-26T12:33:58.747Z","dependency_job_id":null,"html_url":"https://github.com/pablopunk/doctorz","commit_stats":{"total_commits":21,"total_committers":2,"mean_commits":10.5,"dds":0.04761904761904767,"last_synced_commit":"c452cb086c88b9cc9b91968e67be0b322123ff3a"},"previous_names":["pablopunk/doctorz"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pablopunk%2Fdoctorz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pablopunk%2Fdoctorz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pablopunk%2Fdoctorz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pablopunk%2Fdoctorz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pablopunk","download_url":"https://codeload.github.com/pablopunk/doctorz/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246061196,"owners_count":20717388,"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":[],"created_at":"2024-10-02T07:07:05.606Z","updated_at":"2025-03-28T16:25:52.946Z","avatar_url":"https://github.com/pablopunk.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🩺 Doctorz\n\n\u003e Monitors ZFS Pools with `zpool status` and sends you an email if the pool has been degraded.\n\n\n## Config\n\n1. Create a Sendgrid account\n2. Setup an \"sender\" email address in Sendgrid\n2. Get a Sendgrid API key\n\n\n## Docker\n\n```bash\ndocker run --privileged \\\n-e SENDGRID_API_KEY=your-api-key \\\n-e EMAIL_FROM=no-reply@example.com \\\n-e EMAIL_TO=your-email@example.com \\\n-e INTERVAL=600 \\ # if not provided, defaults to 900sec (15 minutes)\npablopunk/doctorz\n```\n\n## Docker compose\n\n```yaml\n  doctorz:\n    container_name: doctorz\n    image: pablopunk/doctorz\n    privileged: true\n    environment:\n      - SENDGRID_API_KEY=your-api-key\n      - EMAIL_FROM=no-reply@example.com\n      - EMAIL_TO=your-email@example.com\n      - INTERVAL=600 # if not provided, defaults to 900sec (15 minutes)\n```\n\n\n## Without docker\n\nIt's meant to run in **Docker**, but if you wanna run it manually I use [bun.sh](https://bun.sh) to run it instead of nodeJS. Make sure you copy `.env.example` to `.env` and replace it with your own values.\n\n```bash\ngit clone https://github.com/pablopunk/doctorz \u0026\u0026 cd doctorz\ncp .env.example .env # edit .env with your own values\nbun run src/index.ts\n```\n\n## If it's degraded\n\nYou'll get an email when it's detected, and won't get notified again until is fixed:\n\n\u003cp\u003e\n\u003cimg src=\"https://github.com/pablopunk/doctorz/blob/main/res/degraded.png?raw=true\" width=\"40%\" /\u003e\n\u003cimg src=\"https://github.com/pablopunk/doctorz/blob/main/res/fixed.png?raw=true\" width=\"40%\" /\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpablopunk%2Fdoctorz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpablopunk%2Fdoctorz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpablopunk%2Fdoctorz/lists"}