Introduction

Whether you use Windows, Linux or Mac, you can use this process to have Bahmni running on your machine for Testing or Development. Note that it is NOT recommended to use this in production. The idea is to download the Bahmni Virtual (Vagrant) Box which is pre-installed with CentOS, and all softwares. To make the vagrant box run on your machine you will need Virtual Box, Vagrant and GIT installed (See steps below). Once you have this Vagrant box running, you can then make changes to file in the box, and see them reflect immediately. If you still wish to go ahead, and make code changes, and deploy them - then development setup will be needed, so that you can modify files in your base OS, and run them inside the Vagrant box after recompilation. 

Perform the following steps to get Bahmni VM setup on your computer

Step 1: Install Git, Virtual Box and Vagrant on your computer

• Git: http://git-scm.com/book/en/v2/Getting-Started-Installing-Git

• VirtualBox:https://www.virtualbox.org/wiki/Downloads

• Vagrant: https://www.vagrantup.com/downloads.html (Please install Vagrant version 1.7 or newer, 2.0.2 is the recommended version)

Step 2: Create a folder bahmni where you would like all project related files to be present

cd /Projects
mkdir bahmni

Step 3: Clone the following projects from Github inside the newly created folder bahmni

cd bahmni
git clone https://github.com/Bahmni/bahmni-vagrant.git

Step 4: From within directory bahmni-vagrant execute "vagrant up" command

This command will download a CentOS Vagrant Box from the internet, and install it on your machine ('vagrant box list' command shows a list of locally installed boxes). 

cd bahmni-vagrant

# Make sure that the command prompt is running "As Administrator" otherwise the next command vagrant up will hang on 'Clearing any previously set network interfaces'. 
#This command will download the Vagrant box from Atlas first time. Next time onwards, the already downloaded vagrant box will be used.
# The download box size is about 2.5 GB. Please ensure you have a good and stable internet connection to download the box. Usually vagrant will continue download from where it got disconnected.

vagrant up

Step 5: You should have Bahmni up and running, and accessible on the below mentioned links

Application	Link	Credentials	Screenshot
Bahmni Home Landing Page	https://192.168.33.10/	-
Bahmni EMR & Clinical UI	https://192.168.33.10/home	superman/Admin123
Lab System (OpenELIS)	http://192.168.33.10/openelis	admin/adminADMIN!
ERP System (Odoo) - Billing and Inventory	http://192.168.33.10:8069/	admin/admin Note: On v0.91 this would go to OpenERP whose credentials are: admin/password (Choose Database "openerp" in top right corner).
OpenMRS - Configuration	https://192.168.33.10/openmrs/	superman/Admin123

Step 6: To halt the VM, you can use the "vagrant halt" command

cd bahmni-vagrant
vagrant halt 
# Use 'vagrant up' next time, to restart the box.

Working Inside the Bahmni Vagrant Box

#ssh into the box
vagrant ssh
# The bahmni code folder of host machine is mapped to /bahmni of the VM
cd /bahmni
# For httpd server (where the EMR UI runs from): 
cd /var/www/
 

Starting / Stopping your Vagrant Box

cd bahmni-vagrant
 
# Stops your vagrant box (and remembers all file system changes)
vagrant halt
 
# Brings your vagrant back on (if you did 'vagrant halt' earlier to stop)
vagrant up
 
# Destroy and free up space - Any changes you made inside the vagrant will also be lost
vagrant destroy
 
# Creates and starts a fresh box (won't download anything) from the originally downloaded Bahmni box template
vagrant up
 

Updating your Vagrant Box to the Latest Version

If you already have a Bahmni vagrant box on your machine, but would like to update to the latest published box, please perform the following steps. 

cd bahmni-vagrant
vagrant halt
 
# See which versions of Bahmni vagrant box are installed on the machine
vagrant box list
# Warning!! This will destroy any changes you made in the vagrant box
vagrant destroy 
 
# (Optional Step) Delete the box template of a specific version if you don't want it, or you want to download it again
vagrant box remove bahmni-team/bahmni --box-version="0.81"

# Will search and download the latest Bahmni vagrant box (about 1.5GB +)
vagrant box update 

# You new box should come up now
vagrant up 

Transferring your Vagrant box to another machine

If you wish to transfer the same vagrant box from your machine to another machine, you can also do that. This has the following advantages: 

1. Any data you setup in your vagrant box will also be available to the other box/machine. 
2. If the other machine doesn't have fast internet access, then also you can perform this machine to machine box transfer, and save on bandwidth.
3. Its quicker than downloading the whole box!

Steps to perform: 

Reference document: https://www.dev-metal.com/copy-duplicate-vagrant-box/

1. Create Reference Box: Create a new vagrant box that has everything from your box packaged into it using the following commands: 

   # Execute these commands from the same folder where your vagrant box is kept.
    
   # Halt vagrant
   vagrant halt
    
   # Create a new .box. This will create a package.box file
   vagrant package

2. Use Box on Target Machine: On the new machine, perform the following steps: 
   1. Create a new folder, say: "D:/my-bahmni-vagrant"
   2. Copy over the "package.box" file and "Vagrantfile" from your machine into the above folder.

   3. Edit the Vagrantfile and do the following: 

      # Change this value as below
      config.vm.box = "my-bahmni-box"
       
      # Add this line to point the url to the package.box
      config.vm.box_url = "file:///d:/my-bahmni-vagrant/package.box"

   4. Save the Vagrant file and execute "vagrant up" command.

Now the vagrant box on the new machine should be up. You can repeat step 2 on other machines, now that you have a package.box as reference for others.

Setting up an AWS Machine using your Vagrant / VM Box Image

Read this document: Exporting your VM to AWS

Direct Download of Vagrant Box

If you are unable to download the box using the "vagrant up" command, you can choose to download it via some other downloader utility directly using this link: 

v0.93.2: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.93.2/providers/virtualbox.box

v0.93.1: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.93.1/providers/virtualbox.box

v0.93: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.93/providers/virtualbox.box

v 0.92: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.92/providers/virtualbox.box

v 0.91: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.91/providers/virtualbox.box

v 0.90: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.90/providers/virtualbox.box

v 0.89: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.89/providers/virtualbox.box

v 0.88: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.88/providers/virtualbox.box 

v 0.87: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.87/providers/virtualbox.box

v 0.86: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.86/providers/virtualbox.box

v 0.85: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.85/providers/virtualbox.box

v 0.83: https://app.vagrantup.com/bahmni-team/boxes/bahmni/versions/0.83/providers/virtualbox.box

After download, rename the box to "package.box". Place the box in your "bahmni-vagrant" folder, and edit the Vagrant file as below: 

# Change this value as below
config.vm.box = "my-bahmni-box"
 
# Add this line to point the url to the package.box
config.vm.box_url = "file:///d:/my-bahmni-vagrant/package.box"

Now save the Vagrantfile. And then execute the "vagrant up" command. 

From Bahmni v0.89, the Bahmni virtualbox comes with oh-my-zsh shell, Git installed. This will helpful for the newbies to navigate inside vagrant box. For details check this PR.