shhhbb, an ssh bbs

connect to the shhhbb.com bbs

use your normal ssh client. you don't need to sign up, just sign in with ssh and the bbs does the rest.

Note: If you need to generate a key, you can use this command to generate a good modern key. ssh-keygen -t ed25519 -C "shhhbb.com bbs key"

ssh -p 2223 shhhbb.com

how to host your own bbs

using shhhbb to host your bbs means anybody with any ssh key can interact with the bbs. as such, it's wise to run as a non-privileged user on a non-critical server, like a vps.

1. download the server program https://github.com/donuts-are-good/shhhbb/releases/latest

2. put your host keys in shhhbb/keys directory.
Note: if you need to generate a new key, try this: ssh-keygen -t ed25519 -C "shhhbb host key"

3. specify a port and run the server like this:

./shhhbb 2223

how to edit the code

the server is MIT licensed. if you don't know what that means, don't worry about it. but the important part of what that means for this program is you can make any changes you like. here are some short instructions to get the code and build it yourself. it's easy, don't worry.

1. clone the repository

git clone https://github.com/donuts-are-good/shhhbb

2. make your changes and save the file. everything happens in main.go

3. build it. all you need installed is Go, which you can get here: https://golang.org

go build

4. Optional: i made a thing that will compile the server for every cpu and os it is compatible with, which is about 30-40 platforms. if you're into that, it's a simple bash tool you can try here: donuts-are-good/release.sh

./release.sh --name "shhhbb" --version "v0.0.2" 

api

the api is designed to allow users to create and retrieve chat messages and posts. it is secured with token-based authentication using bearer tokens.

base url

http://localhost:8080

authentication

all 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.

/token new
      /token list
      /token revoke
      

endpoints

get /chat/messages retrieve the last 100 chat messages.

• parameters: none
• authentication: bearer token required
• response: a json object with a boolean success field and an array data field containing objects with the following properties:
  • sender: the hash of the message sender
  • message: the message body
  • timestamp: the time the message was sent in iso 8601 format

post /chat/create create a new chat message.

• parameters:
  • sender_hash: the hash of the message sender
  • message: the message body
• authentication: bearer token required
• response: a json object with a boolean success field

post /chat/direct/create create a new direct message.

• parameters:
  • sender: the hash of the message sender
  • recipient: the hash of the message recipient
  • message: the message body
• authentication: bearer token required
• response: a json object with a boolean success field

get /posts/list retrieve a list of posts.

• parameters: none
• authentication: bearer token required
• response: a json object with a boolean success field and an array data field containing objects with the following properties:
  • post_id: the id of the post
  • author_hash: the hash of the post author
  • post_body: the post body
  • timestamp: the time the post was created in iso 8601 format

post /posts/create create a new post.

• parameters:
  • author_hash: the hash of the post author
  • post_body: the post body
• authentication: bearer token required
• response: a json object with a boolean success field

get /posts/replies retrieve a list of replies to a post.

• parameters:
  • post_id: the id of the post to retrieve replies for
• authentication: bearer token required
• response: a json object with a boolean success field and an array data field containing objects with the following properties:
  • reply_id: the id of the reply
  • post_id: the id of the post being replied to
  • author_hash: the hash of the reply author
  • reply_body: the reply body
  • timestamp: the time the reply was created in iso 8601 format

post /posts/reply create a new reply to a post.

• parameters:
  • post_id: the id of the post being replied to
  • author_hash: the hash of the reply author
  • reply_body: the reply body
• authentication: bearer token required
• response: a json object with a boolean success field