{"id":18877571,"url":"https://github.com/nftstorage/checkup","last_synced_at":"2025-04-14T18:31:48.401Z","repository":{"id":43398176,"uuid":"463525263","full_name":"nftstorage/checkup","owner":"nftstorage","description":" ***Notice: This repository is no longer maintained.*** ✅ A tool to check up on data stored in dotStorage, ensuring it is available and retrievable.","archived":false,"fork":false,"pushed_at":"2023-02-23T10:29:51.000Z","size":258,"stargazers_count":2,"open_issues_count":2,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-28T07:02:37.219Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/nftstorage.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}},"created_at":"2022-02-25T12:32:27.000Z","updated_at":"2024-07-03T04:42:40.000Z","dependencies_parsed_at":"2023-01-21T14:48:53.850Z","dependency_job_id":null,"html_url":"https://github.com/nftstorage/checkup","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fcheckup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fcheckup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fcheckup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fcheckup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nftstorage","download_url":"https://codeload.github.com/nftstorage/checkup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248936745,"owners_count":21186095,"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-11-08T06:20:03.500Z","updated_at":"2025-04-14T18:31:48.123Z","avatar_url":"https://github.com/nftstorage.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Checkup\n\nA tool to check up on data stored in dotStorage, ensuring it is available and retrievable. It continuously takes random samples of CIDs and exposes prometheus metrics on their availability.\n\n## Usage\n\nDrop a `.env` file in the project root and populate:\n\n```sh\nDATABASE_CONNECTION=\u003cvalue\u003e\nIPFS_CHECK_API_URL=\u003cvalue\u003e\nCLUSTER_API_URL=\u003cvalue\u003e\nCLUSTER_BASIC_AUTH_TOKEN=\u003cvalue\u003e\nPORT=3000 # optional, default shown\nPROM_NAMESPACE=checkup # optional, default shown\nSAMPLE_METHOD=universal # optional, default shown, also randomid (nft.storage only)\nELASTIC_PROVIDER_ADDR=/p2p/Qm... # optional, if set, CIDs will be checked on elastic provider also (assumed ALL CIDs are available here)\nELASTIC_PROVIDER_S3_REGION=\u003cvalue\u003e # optional, required if ELASTIC_PROVIDER_ADDR is set\nELASTIC_PROVIDER_S3_BUCKET=\u003cvalue\u003e # optional, required if ELASTIC_PROVIDER_ADDR is set\nELASTIC_PROVIDER_S3_ACCESS_KEY_ID=\u003cvalue\u003e # optional, required if ELASTIC_PROVIDER_ADDR is set\nELASTIC_PROVIDER_S3_SECRET_ACCESS_KEY=\u003cvalue\u003e # optional, required if ELASTIC_PROVIDER_ADDR is set\n```\n\nReplace the following values as specified:\n\n* `DATABASE_CONNECTION` with the connection string for the database you want read from.\n* `IPFS_CHECK_URL` with an [ipfs-check](https://github.com/aschmahmann/ipfs-check) backend API URL.\n* `CLUSTER_API_URL` with the base URL of the Cluster API.\n* `CLUSTER_BASIC_AUTH_TOKEN` with the base64 encoded basic auth token for the Cluster API.\n\nStart the checker:\n\n```sh\nnpm start\n```\n\nMetrics for reports are available at `http://localhost:3000/metrics`\n\n### Docker\n\nThere's a `Dockerfile` that runs the tool in docker.\n\n```sh\ndocker build -t checkup .\ndocker run -d checkup\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnftstorage%2Fcheckup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnftstorage%2Fcheckup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnftstorage%2Fcheckup/lists"}