{"id":13621050,"url":"https://github.com/donuts-are-good/shhhbb","last_synced_at":"2025-10-16T02:39:10.578Z","repository":{"id":149069798,"uuid":"615166017","full_name":"donuts-are-good/shhhbb","owner":"donuts-are-good","description":"bbs based on SSH","archived":false,"fork":false,"pushed_at":"2025-02-18T16:04:13.000Z","size":94,"stargazers_count":159,"open_issues_count":4,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-06T21:14:59.734Z","etag":null,"topics":["bbs","bulletin-board-system","golang","hacktoberfest","pubnix","ssh","tilde","tildeverse"],"latest_commit_sha":null,"homepage":"https://donuts-are-good.github.io/shhhbb/","language":"Go","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/donuts-are-good.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2023-03-17T05:00:27.000Z","updated_at":"2025-03-15T07:11:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"a649e0a8-3ff7-419f-a624-ba233a2684f0","html_url":"https://github.com/donuts-are-good/shhhbb","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donuts-are-good%2Fshhhbb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donuts-are-good%2Fshhhbb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donuts-are-good%2Fshhhbb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donuts-are-good%2Fshhhbb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/donuts-are-good","download_url":"https://codeload.github.com/donuts-are-good/shhhbb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980844,"owners_count":21027808,"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":["bbs","bulletin-board-system","golang","hacktoberfest","pubnix","ssh","tilde","tildeverse"],"created_at":"2024-08-01T21:01:02.081Z","updated_at":"2025-10-16T02:39:05.555Z","avatar_url":"https://github.com/donuts-are-good.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"\u003cimg width=\"737\" alt=\"image\" src=\"https://user-images.githubusercontent.com/96031819/228712817-54829adf-1dd3-48b4-ba14-16fc53d0e7fd.png\"\u003e\n\n![donuts-are-good's followers](https://img.shields.io/github/followers/donuts-are-good?\u0026color=555\u0026style=for-the-badge\u0026label=followers) ![donuts-are-good's stars](https://img.shields.io/github/stars/donuts-are-good?affiliations=OWNER%2CCOLLABORATOR\u0026color=555\u0026style=for-the-badge) ![donuts-are-good's visitors](https://komarev.com/ghpvc/?username=donuts-are-good\u0026color=555555\u0026style=for-the-badge\u0026label=visitors)\n\n# shhhbb\nssh based BBS \u0026 chat over SSH\n\n\u003cvideo controls\u003e\n  \u003csource src=\"https://user-images.githubusercontent.com/96031819/225815939-1e7c5837-30c9-4d5b-938e-4dcb1b710401.mp4\" type=\"video/mp4\"\u003e\n\u003c/video\u003e\n\n![demo video link](https://user-images.githubusercontent.com/96031819/225815939-1e7c5837-30c9-4d5b-938e-4dcb1b710401.mp4)\n\n\n\n**instructions:** \n1. create a directory called `./keys` \n2. generate an ed25519 keypair in there without password\n`ssh-keygen -t ed25519 -C \"my cool keypair\" -f ./keys/ssh_host_ed25519_key`\n3. launch with `./shhhbb 2223` where `2223` is the port\n\n## api \n\nthe api is designed to allow users to create and retrieve chat messages and posts. it is secured with token-based authentication using bearer tokens.\n\n### base url\n\nhttp://localhost:8080\n\n### authentication\nall endpoints require authentication with a bearer token. to obtain a bearer token, the user must first log in and then authenticate themselves with their token in subsequent requests.\n\n```\n/token new\n/token list\n/token revoke\n```\n\n### endpoints\n\n**get /chat/messages**\n*retrieve the last 100 chat messages.*\n\n- parameters: none\n- authentication: bearer token required\n- response: a json object with a boolean success field and an array data field containing objects with the following properties:\n  - sender: the hash of the message sender\n  - message: the message body\n  - timestamp: the time the message was sent in iso 8601 format\n\n**post /chat/create**\n*create a new chat message.*\n\n- parameters:\n  - sender_hash: the hash of the message sender\n  - message: the message body\n- authentication: bearer token required\n- response: a json object with a boolean success field\n\n**post /chat/direct/create**\n*create a new direct message.*\n\n- parameters:\n  - sender: the hash of the message sender\n  - recipient: the hash of the message recipient\n  - message: the message body\n- authentication: bearer token required\n- response: a json object with a boolean success field\n\n**get /posts/list**\n*retrieve a list of posts.*\n\n- parameters: none\n- authentication: bearer token required\n- response: a json object with a boolean success field and an array data field containing objects with the following properties:\n  - post_id: the id of the post\n  - author_hash: the hash of the post author\n  - post_body: the post body\n  - timestamp: the time the post was created in iso 8601 format\n\n**post /posts/create**\n*create a new post.*\n\n- parameters:\n  - author_hash: the hash of the post author\n  - post_body: the post body\n- authentication: bearer token required\n- response: a json object with a boolean success field\n\n**get /posts/replies**\n*retrieve a list of replies to a post.*\n\n- parameters:\n  - post_id: the id of the post to retrieve replies for\n- authentication: bearer token required\n- response: a json object with a boolean success field and an array data field containing objects with the following properties:\n  - reply_id: the id of the reply\n  - post_id: the id of the post being replied to\n  - author_hash: the hash of the reply author\n  - reply_body: the reply body\n  - timestamp: the time the reply was created in iso 8601 format\n\n**post /posts/reply**\n*create a new reply to a post.*\n\n- parameters:\n  - post_id: the id of the post being replied to\n  - author_hash: the hash of the reply author\n  - reply_body: the reply body\n- authentication: bearer token required\n- response: a json object with a boolean success field\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdonuts-are-good%2Fshhhbb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdonuts-are-good%2Fshhhbb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdonuts-are-good%2Fshhhbb/lists"}