README.md

Bitbus Box

Containerized Bitbus

---

Prerequisites

1. Install Docker

If you don't have docker installed on your computer, you can follow the instructions here: https://docs.docker.com/install/#supported-platforms

2. Install Docker-Compose

Follow the instruction here to install: https://docs.docker.com/compose/install/

---

Usage

Here's an example usage:

1. Clone

git clone https://github.com/interplanaria/bitbusbox.git

2. Write a Bus file

Write a Bus file in the same folder as docker-compose.yml.

Here's an example. Save this to bus.json:

{
  "bitbus": true,
  "name": "weathersv",
  "from": 590000,
  "q": {
    "find": { "out.s1": "1LtyME6b5AnMopQrBPLk4FGN8UBuhxKqrn" },
    "project": { "out.s2": 1, "out.s3": 1 }
  }
}

The resulting folder structure should look something like (Note the bus.json at the end):

./
  Dockerfile
  README.md
  busbox.png
  docker-compose.yml
  run.sh
  bus.json

3. Start

Run in foreground:

docker-compose up

Run in background:

docker-compose up -d

Open your browser at: http://localhost:3007 and you should see it working!

---

Advanced

You can tweak the docker-compose.yml file to change your settings.

• By default it uses Docker Volumes but you can switch it out to any other option.
• By default it uses the port 3007 but you can change it too.