{"id":21913681,"url":"https://github.com/av8ta/ssb-minimal","last_synced_at":"2025-04-16T07:39:34.270Z","repository":{"id":126961139,"uuid":"109365035","full_name":"av8ta/ssb-minimal","owner":"av8ta","description":"A minimal way to get started talking to ssb on a testnet in node","archived":false,"fork":false,"pushed_at":"2019-01-27T03:08:16.000Z","size":13,"stargazers_count":14,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T05:11:32.400Z","etag":null,"topics":["decent","decentralised","nodejs","sbot","scuttlebot","ssb-client","ssb-party","testnet"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/av8ta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-11-03T07:21:15.000Z","updated_at":"2021-06-02T10:10:12.000Z","dependencies_parsed_at":"2023-06-19T07:11:36.127Z","dependency_job_id":null,"html_url":"https://github.com/av8ta/ssb-minimal","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/av8ta%2Fssb-minimal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/av8ta%2Fssb-minimal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/av8ta%2Fssb-minimal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/av8ta%2Fssb-minimal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/av8ta","download_url":"https://codeload.github.com/av8ta/ssb-minimal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249213879,"owners_count":21231096,"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":["decent","decentralised","nodejs","sbot","scuttlebot","ssb-client","ssb-party","testnet"],"created_at":"2024-11-28T18:18:30.719Z","updated_at":"2025-04-16T07:39:34.262Z","avatar_url":"https://github.com/av8ta.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ssb-minimal\n\nA minimal way to get started talking to ssb on a testnet. Assumes you have already [installed sbot globally](https://ssbc.github.io/docs/scuttlebot/install.html) to develop with.\n\nCreate a .ssb-test folder alongside your .ssb folder in HOME\n\nCreate a config file (no file extension) with:\n```json\n{\n  \"caps\": {\n    \"shs\": \"MVZDyNf1TrZuGv3W5Dpef0vaITW1UqOUO3aWLNBp+7A=\",\n    \"sign\": \"qym3eJKBjm0E0OIjuh3O1VX8+lLVSGV2p5UzrMStHTs=\"\n  },\n  \"port\": 8007,\n  \"ws\": {\n    \"port\": 8988\n  },\n  \"ssb_appname\": \"ssb-test\",\n  \"plugins\": {\n    \"ssb-about\": true,\n    \"ssb-backlinks\": true,\n    \"ssb-fulltext\": true\n  }\n}\n```\nshs and sign are the keys I'm using for a testnet. By setting sign, the network can not be linked to the mainnet. Setting sign to null means your network could 'join' or 'leak' to the mainnet, depending on how you perceive that!\n\nTerminal: set ssb_appname env variable. Make sure each terminal you use has the environment variable set\n\npowershell\n```powershell\n$env:ssb_appname=\"ssb-test\"\n```\nbash\n```bash\nset ssb_appname=\"ssb-test\"\n```\n\nEnsure you have those plugins installed to your sbot. If they are not installed already, do this:\n```\nsbot plugins.install ssb-about\nsbot plugins.install ssb-backlinks\nsbot plugins.install ssb-fulltext\n```\n\nDifferent terminal:\n```\nsbot server\n```\n\nnpm start\n\nTo see your message:\n```\nsbot createLogStream\n```\n\nAll going well you should see something like this:\n```powershell\n{\n  \"key\": \"%O+Begs/8ayYUCmr6BzXB4SXttyLq3j6viuyRiwlbzL4=.sha256\",\n  \"value\": {\n    \"previous\": \"%NamYZ9YBc8cw5TlP6fQmO/XDey4sPE3c+QMS2TUIVJk=.sha256\",\n    \"author\": \"@32eYi2kQTUrEcbXI9MD7fjU+oXIQ+jELRLTVCwj9Rrg=.ed25519\",\n    \"sequence\": 4,\n    \"timestamp\": 1509695433805,\n    \"hash\": \"sha256\",\n    \"content\": {\n      \"type\": \"post\",\n      \"text\": \"Hello scuttlers!\"\n    },\n    \"signature\": \"2zHW23M6fupHE+RCDIKBA0TCv5Ft07XqtVc7zBeST/kjsQ2sptJ012tvrj+sBiYG8O3HRkebEeWJC/Jf5EU3Ag==.sig.ed25519\"\n  },\n  \"timestamp\": 1509695433806\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fav8ta%2Fssb-minimal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fav8ta%2Fssb-minimal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fav8ta%2Fssb-minimal/lists"}