~haskell-guy/ssb-haskell

ssb-haskell/README.md -rw-r--r-- 2.0 KiB
759d7bc4 — Haskell Guy README: Note where to post feedback 8 months ago

#Scuttlebutt in Haskell

Scuttlebutt is a decentralised gossiping platform which also works well offline. SSB feed for the project is at @f5ABjSMAR95ajlGST63/xx+XUoty53mlSZZ3GhGbQeE=.ed25519.

This project is under active development (in alpha). USE AT YOUR OWN RISK.

#Contributing

Please post bugs, patches, or requests to #ssb-haskell-dev on Scuttlebutt.

#Building and Installation

Haskell stack is used to build the code and manage dependencies. See their README for how to install it.

Stack can then be used to:

Build the project

stack build

Install the project into your local bin path

stack install

Run the project without installing it

stack run -- help

#Hosting a SSB Room

You can host an SSB room using this project. SSB peers can then use the room to discover and communicate with each other. For more information, refer to the official project.

ssb host-room --help
# Usage: ssb host-room NAME DESCRIPTION HOSTNAME
#   host a room
#
# Available options:
#   NAME                     what's the room called
#   DESCRIPTION              summary of room's purpose
#   HOSTNAME                 IP address or Domain Name to host on. The Domain Name
#                            must resolve.
#   -h,--help                Show this help text

For example:

ssb host-room "the-room" "Movie discussion on a cult-classic" room.lets-discuss.org
# Hosting room for 'net:room.lets-discuss.org:8008~shs:f2Ofh8qBvMNaQSI0RJTf7zr/NEfSOU/RuOXzCMNRu0M=:SSB+Room+PSK3TLYC2T86EHQCUHBUHASCASE18JBV24='