{"id":18901216,"url":"https://github.com/regular/ssb-party","last_synced_at":"2025-08-11T00:06:40.384Z","repository":{"id":66061326,"uuid":"105157547","full_name":"regular/ssb-party","owner":"regular","description":"forked from git-ssb origin","archived":false,"fork":false,"pushed_at":"2017-11-15T02:53:36.000Z","size":17,"stargazers_count":2,"open_issues_count":2,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-05-31T22:10:24.910Z","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/regular.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":"2017-09-28T14:18:10.000Z","updated_at":"2017-11-15T16:34:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"f3babff0-5317-49ea-8fbe-c8418c05b482","html_url":"https://github.com/regular/ssb-party","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/regular/ssb-party","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regular%2Fssb-party","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regular%2Fssb-party/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regular%2Fssb-party/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regular%2Fssb-party/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regular","download_url":"https://codeload.github.com/regular/ssb-party/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regular%2Fssb-party/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269809476,"owners_count":24478545,"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-08-10T02:00:08.965Z","response_time":71,"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-11-08T08:55:29.556Z","updated_at":"2025-08-11T00:06:40.362Z","avatar_url":"https://github.com/regular.png","language":"JavaScript","readme":"# ssb-party\n\nGet a [scuttlebot][] client instance. If scuttlebot isn't running, start it in the background, and keep it running until all the clients have disconnected.\n\n## Usage\n\n```js\nvar createSsbParty = require('ssb-party')\n```\n\n### `createSsbParty([opts, ]cb)`\n\n- `opts.keys`: an [ssb-keys][] instance. default loads from `~/.ssb/secret`\n- `opts.host`: host to connect to or start the server on. default `\"localhost\"`\n- `opts.port`: port to connect to or start the server on. default 8008\n- `opts.appKey`: secret-stack capability key (Buffer). default sbot's appKey\n\nOther properties of the `opts` object will be used as [ssb-config][]\noverrides, but if the server is already running, these will not affect the existing server's config.\n\n### Example\n\nsimplest case: connect to or start a local sbot:\n```\nvar party = require('ssb-party')\n\nparty(function (err, sbot) {\n  // ...\n})\n```\n\n### Config\n\n- `config.timers.keepalive`: minimum time (ms) to keep the server online after the last client disconnects. default: 30s\n- `config.party.out`: where to put standard output of sbot. may be a path (absolute, or relative to ssb's directory), or `false` to discard, or `true` to pass through to the controlling terminal. default: `true`\n- `config.party.err`: where to put standard error of sbot. default: same as `config.party.out`\n\n[scuttlebot]: https://github.com/ssbc/scuttlebot\n[ssb-keys]: https://github.com/ssbc/ssb-keys\n[ssb-config]: https://github.com/ssbc/ssb-config\n[secret-stack]: https://github.com/ssbc/secret-stack\n\n## License\n\nCopyright (c) 2017 [@cel](@f/6sQ6d2CMxRUhLpspgGIulDxDCwYD7DzFzPNr7u5AU=.ed25519)\n\nUsage of the works is permitted provided that this instrument\nis retained with the works, so that any entity that uses the\nworks is notified of this instrument.\n\nDISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregular%2Fssb-party","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregular%2Fssb-party","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregular%2Fssb-party/lists"}