{"id":18551811,"url":"https://github.com/ducktors/arecibo","last_synced_at":"2025-04-06T09:06:42.335Z","repository":{"id":57183469,"uuid":"146724154","full_name":"ducktors/arecibo","owner":"ducktors","description":"Fastify ping responder for Kubernetes Liveness and Readiness Probes","archived":false,"fork":false,"pushed_at":"2025-03-24T19:51:17.000Z","size":657,"stargazers_count":32,"open_issues_count":2,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T10:45:08.321Z","etag":null,"topics":["fastify","fastify-plugin","kubernetes","kubernetes-monitoring","pinger","readiness-probes"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/ducktors.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2018-08-30T09:04:25.000Z","updated_at":"2025-03-17T22:49:25.000Z","dependencies_parsed_at":"2023-12-15T11:29:29.185Z","dependency_job_id":"20030a47-f3b6-45ae-ab80-5509014b1265","html_url":"https://github.com/ducktors/arecibo","commit_stats":{"total_commits":96,"total_committers":10,"mean_commits":9.6,"dds":0.6666666666666667,"last_synced_commit":"da37a0db37637c35d6effd6349bd399ce90ec219"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ducktors%2Farecibo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ducktors%2Farecibo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ducktors%2Farecibo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ducktors%2Farecibo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ducktors","download_url":"https://codeload.github.com/ducktors/arecibo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457799,"owners_count":20941906,"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":["fastify","fastify-plugin","kubernetes","kubernetes-monitoring","pinger","readiness-probes"],"created_at":"2024-11-06T21:10:25.659Z","updated_at":"2025-04-06T09:06:42.314Z","avatar_url":"https://github.com/ducktors.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n---\n\n![ARECIBO](https://user-images.githubusercontent.com/1620916/216600132-30d60aa1-59f7-4f47-8e23-8c14c02baf99.png)\n\n---\n\n![arecibo_telescope_sending_a_signal_into_the_space_during__b5c6335a-ae52-4f9d-9350-fd7953fb5013](https://user-images.githubusercontent.com/1620916/216599766-d30dacd3-1beb-4e11-a4f4-22e5b52fa57c.png)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![CI](https://github.com/ducktors/arecibo/actions/workflows/ci.yaml/badge.svg)](https://github.com/ducktors/arecibo/actions/workflows/ci.yaml) ![pnpm@10.4.1](https://img.shields.io/badge/pnpm-10.4.1-yellow)\n[![NPM version](https://img.shields.io/npm/v/arecibo.svg?style=flat)](https://www.npmjs.com/package/arecibo)\n[![NPM downloads](https://img.shields.io/npm/dm/arecibo.svg?style=flat)](https://www.npmjs.com/package/arecibo)\n[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![Known Vulnerabilities](https://snyk.io/test/github/ducktors/arecibo/badge.svg?targetFile=package.json)](https://snyk.io/test/github/ducktors/arecibo?targetFile=package.json)\n\n\u003c/div\u003e\n\n## Installation\n__Note: Please refer to the table below to find the correct version of Arecibo for your Fastify version.__\n\n\n| Arecibo version | Fastify version | Branch |\n| -- | -- | -- |\n| [v4](https://github.com/ducktors/arecibo/releases/tag/v4.0.1) | Fastify 4, 5 | [master](https://github.com/ducktors/arecibo/tree/master) |\n| [v3](https://github.com/ducktors/arecibo/releases/tag/v3.1.1) | Fastify 3, 4, 5 | not maintained |\n| [v1.1.0](https://github.com/ducktors/arecibo/releases/tag/v1.1.0) | Fastify 2 | deprecated |\n\n\n```bash\npnpm add arecibo\nnpm install arecibo\nyarn add arecibo\n```\n\n## Usage in Node.js\n\n```javascript\nconst arecibo = require('arecibo')\n// or import arecibo from 'arecibo'\n// or import * as arecibo from 'arecibo'\n\nfastify.register(arecibo, {\n  message: 'Put here your custom message', // optional, default to original arecibo message\n  readinessURL: '/put/here/your/custom/url', // optional, deafult to /arecibo/readiness\n  livenessURL: '/put/here/your/custom/url', // optional, deafult to /arecibo/liveness\n  readinessCallback: (req, reply) =\u003e reply.type('text/html').send('Put here your custom message'), // optional\n  livenessCallback: (req, reply) =\u003e reply.type('text/html').send('Put here your custom message'), // optional\n  logLevel: 'error', // optional, defaults to 'info'; can be trace, debug, info, warn, error, and fatal\n})\n\n```\n### Note for TypeScript users\n\nIf you set `\"esModuleInterop\": true` you must import this module using `import arecibo from 'arecibo'`.\n\n## On Kubernetes add deployment manifest\n\n```yaml\n...\n\nlivenessProbe:\n  httpGet:\n    path: /arecibo/liveness\n    port: 80\n    httpHeaders:\n      - name: X-Custom-Header\n        value: Awesome\n  initialDelaySeconds: 15\n  timeoutSeconds: 1\n  periodSeconds: 15\nreadinessProbe:\n  httpGet:\n    path: /arecibo/readiness\n    port: 80\n    httpHeaders:\n      - name: X-Custom-Header\n        value: Awesome\n  initialDelaySeconds: 5\n  timeoutSeconds: 1\n  periodSeconds: 15\n\n...\n```\n\n## How to commit\n\nThis repo uses [Semantic Release](https://github.com/semantic-release/semantic-release) with Conventional Commits.\nReleases are automatically created based on the type of commit message: feat for minor and fix for patch.\n\n```\nfeat: new feature ---\u003e 1.x.0\nfix: fix a bug ---\u003e 1.0.x\n```\n\n\n## Reference\n* \u003ca href=\"https://github.com/fastify/fastify\"\u003eFastify\u003c/a\u003e\n* \u003ca href=\"https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/\"\u003eConfigure Liveness and Readiness Probes\u003c/a\u003e\n* \u003ca href=\"https://www.youtube.com/watch?v=mxEvAPQRwhw\"\u003eKubernetes Health Checks with Readiness and Liveness Probes (Kubernetes Best Practices)\u003c/a\u003e\n\n## Fun fact: where does the name come from?\nThe name is inspired by the Arecibo message, a 1974 interstellar radio message carrying basic information about humanity and Earth sent to globular star cluster M13 in the hope that extraterrestrial intelligence might receive and decipher it. The message was broadcast into space a single time via frequency modulated radio waves at a ceremony to mark the remodelling of the Arecibo radio telescope in Puerto Rico on 16 November 1974.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fducktors%2Farecibo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fducktors%2Farecibo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fducktors%2Farecibo/lists"}