Skip to content

Latest commit

 

History

History
100 lines (80 loc) · 2.48 KB

installation.md

File metadata and controls

100 lines (80 loc) · 2.48 KB

Server Installation

Micboard server can be installed on many different platforms. For small and portable systems, Micboard can run on a Raspberry Pi hidden in the back of a rack. Ubuntu Server is recommended for large permanent installations.

The macOS app provides a great way to try Micboard before purchasing additional hardware.

Debian (Ubuntu & Raspberry Pi)

Install git, python3-pip, and Node.js

$ sudo apt-get update
$ sudo apt-get install git python3-pip
$ curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
$ sudo apt-get install nodejs

Download micboard

$ git clone https://github.com/karlcswanson/micboard.git

Install micboard software dependencies via npm and pip

$ cd micboard/
$ npm install --only=prod
$ pip3 install -r py/requirements.txt

build the micboard frontend and run micboard

$ npm run build
$ python3 py/micboard.py

Edit User and WorkingDirectory within micboard.service to match your installation and install it as a service.

$ sudo cp micboard.service /etc/systemd/system/
$ sudo systemctl start micboard.service
$ sudo systemctl enable micboard.service

Check the configuration docs for more information on configuring micboard.

macOS - Desktop Application

Download and run micboard from the project's GitHub Release page. Add RF devices to the 'Slot Configuration' and press 'Save'.

Check the configuration docs for more information on configuring micboard.

macOS - From Source

Install the Xcode command-line tools

$ xcode-select --install

Install the homebrew package manager

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Install python3 and node

$ brew install python3 node

Download Micboard

$ git clone https://github.com/karlcswanson/micboard.git

Install micboard software dependencies via npm and pip

$ cd micboard/
$ npm install --only=prod
$ pip3 install -r py/requirements.txt

build the micboard frontend and run micboard

$ npm run build
$ python3 py/micboard.py

Check the configuration docs for more information on configuring micboard.

Restart micboard

$ python3 py/micboard.py

Docker

Download micboard from github

$ git clone https://github.com/karlcswanson/micboard.git

Build and run docker image

$ cd micboard/
$ docker build -t micboard .
$ docker-compose up