Merge pull request #3 from Opendigitalradio/nextHEADmaster

v3.0.0

2 files changed, 52 insertions, 0 deletions

diff --git a/vagrant/README.md b/vagrant/README.md
new file mode 100644
index 0000000..3f24c68
--- /dev/null
+++ b/vagrant/README.md
@@ -0,0 +1,37 @@
+# Introduction
+[Vagrant](https://www.vagrantup.com) provides easy to configure, reproducible, and portable work environments on top of virtual management software like [Virtualbox](https://www.virtualbox.org/).
+
+With Vagrant and Virtualbox, you can run the ODR-mmbTools regardless of the operating system you are using, such as Windows, MacOS, *BSD or any non-Debian Linux.
+
+# Setup
+1. Install Virtualbox for your operating system
+1. Install the Virtualbox Extension pack
+1. Install Vagrant for your operating system
+1. Clone this repository or copy the Vagrantfile on your host
+1. Create and start the virtual environment:
+    ```
+    # Go to the directory that contains the Vagrantfile
+    vagrant up
+    ```
+1. Access the virtual session to build the ODR-mmbTools suite:
+    ```
+    vagrant ssh
+    ```
+1. Follow the instructions of the **README.md** in the install folder to build the ODR-mmbTools suite
+1. Exit the virtual session with the command **exit**
+1. Connect the SoapySDR transceiver device to your physical host where VirtualBox is running
+1. Open VirtualBox and add a USB filter that relates to your SoapySDR device to the **odr-mmb** session
+1. Restart the **odr-mmbtools** VirtualBox session with Vagrant:
+    ```
+    vagrant reload
+    ```
+
+# Operations
+Once the ODR-mmbTools are installed, you no longer need to access the virtual session, unless you need to make configuration changes.
+
+Here are the url to access the following web interfaces:
+- Supervisor: http://localhost:8001
+- Multiplex Manager: http://localhost:8002
+- Encoder Manager: http://localhost:8003
+
+You can monitor the output of odr-DabMux with dablin on localhost:9201
\ No newline at end of file
diff --git a/vagrant/Vagrantfile b/vagrant/Vagrantfile
new file mode 100644
index 0000000..c61f0c8
--- /dev/null
+++ b/vagrant/Vagrantfile
@@ -0,0 +1,15 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+    config.vm.box = "generic/debian11"
+    config.vm.network "forwarded_port", guest: 8001, host: 8001
+    config.vm.network "forwarded_port", guest: 8002, host: 8002
+    config.vm.network "forwarded_port", guest: 8003, host: 8003
+    config.vm.network "forwarded_port", guest: 9201, host: 9201
+    config.vm.provider "virtualbox" do |vb|
+      vb.name = "odr-mmbtools"
+      vb.customize ['modifyvm', :id, '--usbxhci', 'on']
+    end
+  end
+  
\ No newline at end of file