{"id":19112381,"url":"https://github.com/actionhero/actionhero-socket-server","last_synced_at":"2026-02-19T07:03:02.040Z","repository":{"id":35448825,"uuid":"217777816","full_name":"actionhero/actionhero-socket-server","owner":"actionhero","description":"A TCP and JSON server for actionhero","archived":false,"fork":false,"pushed_at":"2024-10-01T02:44:29.000Z","size":807,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-09T20:25:17.217Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/actionhero.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,"zenodo":null}},"created_at":"2019-10-26T22:40:43.000Z","updated_at":"2024-07-01T15:58:25.000Z","dependencies_parsed_at":"2023-02-17T08:30:50.152Z","dependency_job_id":"0d8d7ecf-fed7-4a8b-9ed6-e0ca361b2e24","html_url":"https://github.com/actionhero/actionhero-socket-server","commit_stats":{"total_commits":200,"total_committers":5,"mean_commits":40.0,"dds":"0.16000000000000003","last_synced_commit":"182c98cf078e336f8241a0cf9b5dc597cf268a41"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/actionhero/actionhero-socket-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actionhero%2Factionhero-socket-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actionhero%2Factionhero-socket-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actionhero%2Factionhero-socket-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actionhero%2Factionhero-socket-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/actionhero","download_url":"https://codeload.github.com/actionhero/actionhero-socket-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actionhero%2Factionhero-socket-server/sbom","scorecard":{"id":163586,"data":{"date":"2025-08-11","repo":{"name":"github.com/actionhero/actionhero-socket-server","commit":"1f3a7ad6e177296a2a5cb4cb49ae2269d9f79bb2"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"name":"Code-Review","score":-1,"reason":"Found no human activity in the last 30 changesets","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/actionhero/actionhero-socket-server/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/actionhero/actionhero-socket-server/test.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":2,"reason":"8 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-75v8-2h7p-7m2m","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T14:15:36.937Z","repository_id":35448825,"created_at":"2025-08-16T14:15:36.937Z","updated_at":"2025-08-16T14:15:36.937Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29605806,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-19T06:47:36.664Z","status":"ssl_error","status_checked_at":"2026-02-19T06:45:47.551Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-11-09T04:32:55.099Z","updated_at":"2026-02-19T07:03:02.024Z","avatar_url":"https://github.com/actionhero.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Actionhero Socket Server\n\n[![test](https://github.com/actionhero/actionhero-socket-server/actions/workflows/test.yml/badge.svg)](https://github.com/actionhero/actionhero-socket-server/actions/workflows/test.yml)\n\nAs of Actionhero v21, the socket server is not included with Actionhero by default. You can add it (this package) via `npm install actionhero-socket-server`.\n\nAs of version `3.0.0` of this package, Actionhero v28+ is required.\n\n```shell\n❯ telnet localhost 5000\nTrying 127.0.0.1...\nConnected to localhost.\nEscape character is '^]'.\n{\"welcome\":\"actionhero.welcomeMessage\",\"context\":\"api\"}\nrandomNumber\n{\"randomNumber\":0.11296216329530862,\"stringRandomNumber\":\"Your random number is 0.11296216329530862\",\"context\":\"response\",\"messageId\":\"8778822d-0953-4d0c-9c04-98cd53b53b7d\"}\nexit\n{\"status\":\"Bye\",\"context\":\"api\"}\nConnection closed by foreign host.\n```\n\n## Installation\n\n1. Add the package to your actionhero project: `npm install actionhero-socket-server --save`\n2. Copy the config file into your project `cp ./node_modules/actionhero-socket-server/src/config/socket.ts src/config/socket.ts`\n3. Enable the plugin:\n\n```ts\n// in config/plugins.ts\nimport * as path from \"path\";\n\nexport const DEFAULT = {\n  plugins: () =\u003e {\n    return {\n      \"actionhero-socket-server\": {\n        path: path.join(\n          __dirname,\n          \"..\",\n          \"..\",\n          \"node_modules\",\n          \"actionhero-socket-server\"\n        ),\n      },\n    };\n  },\n};\n```\n\n4. Add a serializer for errors:\n\n```ts\n// in config/errors.ts\n// you are adding config.errors.serializers.socket\n\nsocket: error =\u003e {\n  if (error.message) {\n    return String(error.message);\n  } else {\n    return error;\n  }\n},\n```\n\n## Options\n\nAll options are exposed via the config file:\n\n```ts\nconst namespace = \"socket\";\n\ndeclare module \"actionhero\" {\n  export interface ActionheroConfigInterface {\n    [namespace]: ReturnType\u003ctypeof DEFAULT[typeof namespace]\u003e;\n  }\n}\n\nexport const DEFAULT = {\n  [namespace]: () =\u003e {\n    return {\n      enabled: true,\n      // TCP or TLS?\n      secure: false,\n      // Passed to tls.createServer if secure=true. Should contain SSL certificates\n      serverOptions: {},\n      // Port or Socket\n      port: 5000,\n      // Which IP to listen on (use 0.0.0.0 for all)\n      bindIP: \"0.0.0.0\",\n      // Enable TCP KeepAlive pings on each connection?\n      setKeepAlive: false,\n      // Delimiter string for incoming messages\n      delimiter: \"\\n\",\n      // Maximum incoming message string length in Bytes (use 0 for Infinite)\n      maxDataLength: 0,\n    };\n  },\n};\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factionhero%2Factionhero-socket-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factionhero%2Factionhero-socket-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factionhero%2Factionhero-socket-server/lists"}