{"id":23938066,"url":"https://github.com/plebbit/plebbit-ipni","last_synced_at":"2026-05-14T01:34:11.911Z","repository":{"id":255935911,"uuid":"853911448","full_name":"plebbit/plebbit-ipni","owner":"plebbit","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-07T21:11:03.000Z","size":65974,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-24T03:42:49.290Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/plebbit.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":"2024-09-07T22:01:09.000Z","updated_at":"2024-12-07T21:11:08.000Z","dependencies_parsed_at":"2024-12-07T22:28:42.356Z","dependency_job_id":null,"html_url":"https://github.com/plebbit/plebbit-ipni","commit_stats":null,"previous_names":["plebbit/plebbit-ipni"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/plebbit/plebbit-ipni","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plebbit%2Fplebbit-ipni","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plebbit%2Fplebbit-ipni/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plebbit%2Fplebbit-ipni/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plebbit%2Fplebbit-ipni/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plebbit","download_url":"https://codeload.github.com/plebbit/plebbit-ipni/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plebbit%2Fplebbit-ipni/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":284566169,"owners_count":27027039,"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","status":"online","status_checked_at":"2025-11-15T02:00:06.050Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-01-06T02:18:21.023Z","updated_at":"2025-11-15T14:08:32.838Z","avatar_url":"https://github.com/plebbit.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"#### introduction\n\nIt is required to run `index-provider`, `storetheindex`, `indexstar` and `proxy-server`\n\n- `index-provider` is required to PUT/announce from kubo to `index-provider`\n- `storetheindex` is required to sync with `index-provider` and serve a `/cid/{cid}` endpoint (like https://cid.contact/cid/{cid})\n- `indexstar` is required to translate `/cid/{cid}` into `/routing/v1/providers/{cid}` (like https://specs.ipfs.tech/routing/http-routing-v1/)\n- `proxy-server` is required to forward `GET /routing/v1/providers/{cid}` to `indexstar` and `PUT /routing/v1/providers` to `index-provider` \n\n#### getting started with docker\n```\ngit clone https://github.com/plebbit/plebbit-ipni.git \u0026\u0026 cd plebbit-ipni\n\n# init config\nsudo apt install jq\nscripts/init-config.sh\n\n# close ports because we're docker in network host mode\nsudo ufw default deny incoming\nsudo ufw default allow outgoing\nsudo ufw allow ssh\nsudo ufw allow http\nsudo ufw --force enable\n\n# install docker and docker-compose\nsudo apt install docker.io\nsudo curl -L \"https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)\" -o /usr/local/bin/docker-compose\nsudo chmod +x /usr/local/bin/docker-compose\n\ndocker-compose up\n```\n\n#### getting started without docker\n```\ngit clone https://github.com/plebbit/plebbit-ipni.git \u0026\u0026 cd plebbit-ipni\n\n# install node.js\nsudo apt install nodejs npm \u0026\u0026 sudo npm install -g n \u0026\u0026 sudo n latest\nnpm install\n\n# init config\nsudo apt install jq\nscripts/init-config.sh\n\n# close all ports\nsudo ufw default deny incoming\nsudo ufw default allow outgoing\nsudo ufw allow ssh\nsudo ufw allow http\nsudo ufw allow 9100/tcp # prometheus node exporter\nsudo ufw --force enable\n\n# launch all required services with nohup so they keep running forever\nPROVIDER_PATH=.index-provider nohup bin/index-provider daemon \u0026\nSTORETHEINDEX_PATH=.storetheindex nohup bin/storetheindex daemon \u0026\nINDEXSTAR_PATH=.indexstar nohup bin/indexstar --listen :7777 --backends http://127.0.0.1:3000 --providersBackends http://no \u0026\nnohup node ./proxy-server.js \u0026\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplebbit%2Fplebbit-ipni","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplebbit%2Fplebbit-ipni","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplebbit%2Fplebbit-ipni/lists"}