Skip to content

Latest commit

 

History

History
125 lines (83 loc) · 6.04 KB

INSTALL.md

File metadata and controls

125 lines (83 loc) · 6.04 KB
Raw

Installing OpenBAS

Welcome to the installation instructions for OpenBAS! This guide is intended to walk you through setting up your local OpenBAS server.

System Requirements

OpenBAS requires either Ubuntu Server 14.04 or Ubuntu Desktop 14.04 (Trusty Tahr). We recommend having at least:

  • 1 GHz processor
  • 2 GB RAM
  • 5 GB disk space

Any relatively recent consumer-grade machine from the past 5 years should have no problem running Ubuntu and OpenBAS. If you want to do a real deployment, we recommend installing OpenBAS on a dedicated Ubuntu machine. If you are interested in sampling the install process, you can achieve this by using a virtual machine.

Installing Ubuntu 14.04

Ubuntu 14.04 is available for free download from http://www.ubuntu.com/download/desktop/. The easiest installation methods are either from DVD or from a USB thumbstick (instructions for how to do this from Ubuntu, Windows or Mac OS X are all available here).

Once you have your DVD or your USB drive with Ubuntu 14.04 loaded, follow the directions at http://www.ubuntu.com/download/desktop/install-ubuntu-desktop to install. The instructions are for the Ubuntu Desktop edition, which includes a graphical interface that is familiar and easier to use for users newer to Ubuntu. However, because OpenBAS provides a web-based interface, running a graphical environment on your OpenBAS server is not necessary. The Ubuntu Server edition will work just as well, if not better, than the Desktop edition.

NOTE: do not forget the username and password that you input during the installation process!

Using a Virtual Machine

A virtual machine allows you to emulate another operating system on your computer, regardless of which operating system you are running. VirtualBox is a free virtual machine. Download the appropriate VirtualBox for your operating system (~128 MB) and download Ubuntu using the links above. When you start up VirtualBox, press "New" to create a new virtual machine, and follow the installation wizard along with the Ubuntu installation instructions (linked above) to create a new Ubuntu installation.

Installing

  1. Open the Terminal: If you are on Ubuntu Desktop, open up the Terminal application by pressing Ctl-Alt-T (pressing the 'Control', 'Alt' and the 't' keys at the same time). If you are on Ubuntu Server, you should already be looking at a terminal. If you aren't, turn your computer on.

NOTE: when you begin the installation, make sure you are in your home directory. If you are unsure, run the command cd in the terminal -- this will place you in your home directory.

  1. Make sure you have curl installed: type the following command into the Terminal and press 'Enter':
which curl

If this gives you output, like printing out /usr/bin/curl, then you are fine! If not, you will need to install it:

sudo apt-get install -y curl

You will probably need to type in your password.

  1. Install OpenBAS: We've made this part very easy! Simply type into the terminal the following:
curl http://install.openbas.cal-sdb.org/ | sudo bash -

which will install and configure your system to run OpenBAS. It will tell you exactly what it is doing, and by the end of the process, your computer should have OpenBAS installed and running.

  1. Configure the sMAP Archiver (this part will soon be integrated into step 3)

    sudo apt-get install -y powerdb2

    This will ask if you want to create a superuser (type 'yes' and press enter). Enter a username, an optional email, and a password.

  2. After powerdb2 is installed, go to http://servername/admin and type in the username and password you created in the last step. If you are installing on a machine locally, this would be http://localhost/admin. Click '+Add' next to 'Subscriptions', enter a description (e.g. 'OpenBAS deployment') and replace the 'Key' field with the default key:

lVzBMDpnkXApJmpjUDSvm4ceGfpbrLLSd9cq

Then click 'Save'.

  1. At this point, you have now installed all the needed OpenBAS software. You can now proceed to configuration your installation for this building.

Getting Started

Note: if you are running anti-virus software, it can misclassify OpenBAS's discovery service as a malignant process and block your access to OpenBAS. Please disable any anti-virus on your personal computer when installing OpenBAS.

Links generated:

When first bringing up OpenBAS for your installation, follow the following steps:

  1. Create rooms: visit http://servername/building e.g http://localhost:3000/building and create some rooms, making sure to place markers on the map.
  2. Plug in devices!
  3. Configure devices on the status page http://servername/status e.g http://localhost:3000/status

Running a virtual building

If you do not have devices to plug in, or are simply wanting to evaluate the system in a virtual machine, you can also utilise our support for virtual devices. A small representative set of preconfigured virtual devices can be added to the system by executing:

curl http://install.openbas.cal-sdb.org/vbuilding | sudo bash -

Troubleshooting

  1. When I curl into sudo bash, nothing happens after the curl output.

    In some cases, the prompt for sudo can be hidden. The system is waiting for you to enter your password before proceeding. We recommend running a simple sudo command beforehand to cache the password for sudo so that this does not happen, for example:

    sudo echo

    before running a curl into sudo.