Skip to content
An easy-to-host server that runs an SSB "Pub"
TypeScript HTML
Branch: master
Clone or download
Pull request Compare This branch is 2 commits ahead, 49 commits behind staltz:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
pages
src
stub-typings
tests
.gitignore
Dockerfile
LICENSE
README.md
docker-compose.yaml
package.json
screenshot.png
tsconfig.json
tslint.json

README.md

Easy Secure Scuttlebutt Pub

easy-ssb-pub is an easy-to-host server that runs an SSB "Pub".

screenshot

Secure Scuttlebutt (SSB) is an impressive peer-to-peer network that can be used for metadata, identity, and particularly, messaging. SSB is an ideal protocol for a social network. There is already a social network on SSB, called Patchwork.

However, to join the wider SSB network, you must get a dedicated invitation from a "Pub" server. Also, hosting a Pub server is not the easiest task. In order to improve adoption of SSB, this project makes it easy to deploy an SSB Pub. Once the Pub is running, it has a light frontend page where anyone can get freely request a fresh invitation.

Visit one of these

If you want to visit an Easy SSB Pub, here are a few known links (potentially ephemeral or broken):

How to deploy

You will need a server that supports a TCP sockets on ports 80, 8008 and 8007. This means Heroku or Zeit Now will not work. Recommended services for servers-on-demand: Digital Ocean Docker Droplet, UpCloud, Amazon LightSail, Vultr, Linode, etc.

  1. Acess your server via shell (e.g. SSH)
  2. Install Docker and Docker Compose
  3. git clone https://github.com/staltz/easy-ssb-pub.git
  4. cd easy-ssb-pub
  5. PUB_URL=publicurltoyourserv.er docker-compose up -d

After the container has been created, stop/start/restart the server using:

  • docker stop easy-ssb-pub
  • docker start easy-ssb-pub
  • docker restart easy-ssb-pub

OR

  1. Access your server via shell (e.g. SSH)
  2. docker pull staltz/easy-ssb-pub
  3. docker run -e "PUB_URL=publicurltoyourserv.er" -v $HOME/.ssb:/root/.ssb -p 80:80 -p 8008:8008 -p 8007:8007 -m 450M --memory-swap 1G --restart=unless-stopped --name ssb-pub -d staltz/easy-ssb-pub

OR

  1. Access your server via shell (e.g. SSH)
  2. apt-get install -y libleveldb-dev curl libc6 libcurl3 zlib1g libtool autoconf
  3. Install nvm: curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash
  4. Restart the shell
  5. nvm install v6.9.1
  6. git clone https://github.com/staltz/easy-ssb-pub.git
  7. npm install
  8. PUB_URL=publicurltoyourserv.er npm start
You can’t perform that action at this time.