Categorygithub.com/skycoin/bbs
repository
0.2.0-alpha
Repository: https://github.com/skycoin/bbs.git
Documentation: pkg.go.dev
Overview
Dependencies
0
Dependents
0

# Packages

No description provided by the author
No description provided by the author

# README

Skycoin BBS

Skycoin BBS is a next generation decentralised social network (BBS stands for Bulletin Board System).

Skycoin BBS uses the Skycoin CX Object System (CXO) to store and synchronise data between nodes.

Skycoin BBS Showcase 4 - YouTube

Building Skycoin BBS

First ensure that go, npm, zip and ng are installed and the GOPATH environment variable is set.

BBS Node

To get the source code, dependencies and build BBS Node:

go get github.com/skycoin/bbs/cmd/bbsnode

The executables will be in $GOPATH/bin.

Optionally, you can then package BBS Node by running bash script provided: pkg/package.sh.

cd $GOPATH/src/github.com/skycoin/bbs/pkg

bash package.sh

Built binaries and static files will be located in pkg/build/ folder.

Running Skycoin BBS

Skycoin BBS Node is a single binary executable that can be ran with the following flags:

  • -dev (default: false) Serves GUI static files from Skycoin BBS location in $GOPATH.

  • -master (default: false) Enables the node to host a port for submitting content to boards.

  • -memory (default: false) Disables the node from saving to disk. By default; user files, cxo database, node connections and subscriptions are saved to disk.

  • -config-dir (default: "") Sets the directory used to store configuration files of Skycoin BBS. Leave blank to use default location of $HOME/.skybbs.

  • -cxo-port (default: 8998) Port that CXO listens on (self-replication database).

  • -cxo-rpc (default: false) Whether to enable CXO RPC Port (for admin control).

  • -cxo-rpc-port (default: 8997) Port used for CXO RPC (if enabled).

  • -sub-port (default: 6421) Port used to receive content submission to hosted boards (if node is master).

  • -http-port (default: 7410) Port to serve JSON API and GUI.

  • -http-gui (default: true) Enables serving GUI.

  • -http-gui-dir (default: "") Set's directory where static files are to be served from. Leave blank to use ./static/dist (unless if -dev flag is set).

Using Skycoin BBS

There are currently two ways of interacting with Skycoin BBS.

  • Web interface - By default, the flag -http-gui is enabled. Hence, when BBS is launched, the web gui will be opened via the system browser.

  • Restful json api - This is ideal for controlling nodes without a graphical user interface (in a server), or for building applications or administrator tools. Documentation for the api is provided as a Postman Collection located at docfiles/postman_collection.json.

Participate

Telegram