{"id":16526829,"url":"https://github.com/silverbucket/node-webfinger-service","last_synced_at":"2025-10-28T10:30:35.020Z","repository":{"id":5538285,"uuid":"6741729","full_name":"silverbucket/node-webfinger-service","owner":"silverbucket","description":"a webfinger service implementation in node.js","archived":false,"fork":false,"pushed_at":"2023-12-15T17:53:59.000Z","size":17,"stargazers_count":7,"open_issues_count":3,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-08T18:11:23.351Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/silverbucket.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":"2012-11-18T00:11:52.000Z","updated_at":"2024-05-09T17:43:38.000Z","dependencies_parsed_at":"2025-02-13T09:43:02.768Z","dependency_job_id":null,"html_url":"https://github.com/silverbucket/node-webfinger-service","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/silverbucket/node-webfinger-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbucket%2Fnode-webfinger-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbucket%2Fnode-webfinger-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbucket%2Fnode-webfinger-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbucket%2Fnode-webfinger-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/silverbucket","download_url":"https://codeload.github.com/silverbucket/node-webfinger-service/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbucket%2Fnode-webfinger-service/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281424580,"owners_count":26499020,"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-10-28T02:00:06.022Z","response_time":60,"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":"2024-10-11T17:30:16.599Z","updated_at":"2025-10-28T10:30:34.726Z","avatar_url":"https://github.com/silverbucket.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-webfinger-service\n\na webfinger service implementation in node.js\n\n## Introduction\n\nThis is a very simple WebFinger service written for node.js. It only supports JSON at the moment, and could very well have bugs. Feedback, contributions and bug reports welcome.\n\n\n## Install\n```\n$ git clone git://github.com/silverbucket/node-webfinger-service.git\n$ cd node-webfinger-service\n$ npm install\n```\n\n## Setup\n\n#### 1. Basic config\n\n```\n$ cp config.js.example config.js\n```\n\nEdit the `config.js` and set your domain name, and the protocol (http or https) that you will receive requests on.\n\n#### 2. User data\n\nAll of the user data lives in the `resource/acct/` directory. Each file is treated as a username when webfinger-service does it's lookup (it doesn't actually check for any system accounts). An example user data file is there named `user`, and looks like this:\n\n```javascript\n  module.exports = {\n    \"subject\" : \"acct:user@example.com\",\n    \"links\" : [\n      {\n        \"rel\" : \"http://webfinger.net/rel/avatar\",\n        \"href\" : \"http://exmaple.com/images/avatar.jpg\"\n      },\n      {\n        \"rel\" : \"http://webfinger.net/rel/profile-page\",\n\t\"href\" : \"http://www.example.com/user/profile\"\n      },\n      {\n        \"rel\" : \"http://packetizer.com/rel/blog\",\n        \"href\" : \"http://exmaple.com/blog\"\n      }\n    ]\n  };\n```\n\nSo, if your filename is `bob` then lookups for `bob@[yourdomain]` will return\nthat json object.\n\n#### 3. Setup a proxy ( HAProxy )\n\nYou can also setup nginx to forward, but I've only tested with HAProxy.\n\n```\nfrontend public\n  bind *:80\n  ...\n  acl is_webfinger path_beg -i /.well-known\n  use_backend webfinger if is_webfinger\n  ...\n  backend webfinger\n    timeout server 30s\n    option httpclose\n    option forwardfor\n    server srv1 127.0.0.1:9110  # or whatever port you chose in config.js\n```\n\n**Don't forget to restart HAProxy**\n\n#### 4. Start the webfinger-service\n\n```\n$ bin/webfinger-service\n```\n\n## Example request/response\nA request like this: \n`GET http://localhost:9110/.well-known/webfinger?resource=acct:user@example.com`\n\nShould provide a response like this:\n```javascript\n{\n  \"subject\":  \"acct:user@example.com\",\n  \"links\": [\n    {\n      \"rel\": \"http://webfinger.net/rel/avatar\",\n      \"href\": \"http://exmaple.com/images/avatar.jpg\"\n    },\n    {\n      \"rel\": \"http://webfinger.net/rel/profile-page\",\n      \"href\": \"http://www.example.com/user/profile\"\n    },\n    {\n      \"rel\": \"http://packetizer.com/rel/blog\",\n      \"href\": \"http://exmaple.com/blog\"\n    }\n  ]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilverbucket%2Fnode-webfinger-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsilverbucket%2Fnode-webfinger-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilverbucket%2Fnode-webfinger-service/lists"}