Skip to content

skycoin/bbs

Repository files navigation

skycoin bbs logo

Skycoin BBS

GoReportCard Telegram group link Build Status

Skycoin BBS uses the Skycoin CX Object System (CXO) to store and synchronise data between nodes and the Skycoin Messenger (net) for inter-node content submission.

Skycoin BBS Showcase 4 - YouTube

Install

Go 1.9+ Installation and Setup

Golang 1.9+ Installation/Setup

After installation, ensure that the GOPATH environmental variable is set and that $GOPATH/bin is added to the PATH environment variable.

Dependencies

Dependencies are managed with dep.

To install dep:

go get -u github.com/golang/dep

dep vendors all dependencies into the repo.

Download and Compile BBS Executables

go get https://github.com/skycoin/bbs/...

This will download github.com/skycoin/bbs to $GOPATH/src/github.com/skycoin/bbs.

You can also clone the repo directly with git clone https://github.com/skycoin/bbs, but it must be cloned to this path: $GOPATH/src/github.com/skycoin/bbs.

Static Files For The Web Thin Client

Building instructions for static files can be found in static/README.md.

Run

$ bbsnode

For more detailed instructions:

The script run.sh is provided as a convenient to run BBS, serving static files in static/dist.

$ ./run.sh

Docker

Pull docker image.

$ docker pull skycoin/bbs

Create a docker volume.

$ docker volume create bbs-data

Run Skycoin BBS.

$ docker run -p 8080:8080 -p 8998:8998 -p 8996:8996 -v bbs0:/data skycoin/bbs

List network interfaces.

$ ifconfig

Use CLI.

# help menu
$ docker run skycoin/bbs bbscli -h

# interact with bbs node
$ docker run skycoin/bbs bbscli -a 172.17.0.1:8996 messengers discover

Command-line interface

The Command-line interface is for administration control over the BBS node.

Detailed instructions are located at cmd/bbscli/README.md.

Documentation

Please make use of the Skycoin BBS Wiki!

Participate

Telegram