OpenMRS Appliance

Contents

[edit]

Welcome

The OpenMRS appliance is a virtual appliance (also known as a virtual machine or VM). A virtual appliance is a fully pre-installed and pre-configured application and operating system environment. This is a great way for you to try out OpenMRS without installing all the OpenMRS requirements (Java, Tomcat, MySQL, etc) and configuring them to work on your computer.

With a virtual appliance, all you have to do is download it, uncompress it, and double click it to run. Uninstalling is even easier, just delete the virtual appliance folder.

[edit]

Requirements

You will need 384 MB of RAM and 1 GB of hard disk space free to install and use this appliance. You will also need the 7z file archiver to uncompress the appliance and a virtual machine player to run it. Use the links below to get these components.

Instead of VMWare Player, you can also try VirtualBox. It is free, open source and runs on Windows, Mac and Linux.

[edit]

Installation

Download the latest OpenMRS appliance from the Downloads page. The file you get will be called OpenMRS_1.3.0.vmimage.7z

Double click the OpenMRS.7z to uncompress it. It should use the 7z archiver you downloaded earlier. You should now get an OpenMRS 1.3.0 folder. If you open that folder you will see two files: OpenMRS.vmdk (~800MB) and OpenMRS.vmx (~4KB).

Double click the OpenMRS.vmx file and it should launch your VM player and start the OpenMRS appliance.

There will be a lot of text on the screen, but the last thing you should see is "Welcome to OpenMRS. Go to http://appliance.ip.address:8180/openmrs". When you see that, launch your web browser and go to that address.

Login with admin/test and start using OpenMRS.

[edit]

Notes

The appliance is built from an Ubuntu 8.04.1/ JeOS. You can treat it like any Ubuntu Server Edition installation. It uses Java 6, Tomcat 5.5, and MySQL Server 5.

Passwords are:

  • OpenMRS: admin/test
  • VM/MySQL user: openmrs/openmrs
  • VM/MySQL/Tomcat admin: root/openmrs

The appliance assumes that your network is DHCP enabled. If you do not get the "Welcome to OpenMRS" message when it starts, your appliance is not getting an IP. Switch the appliance into NAT mode and reboot it.

The appliance is about 800MB and is limited to a 8GB virtual drive. If you need more space, consider adding another virtual drive. See your VM player's documentation for more details.

The appliance is not meant for production environments. It uses low RAM requirements, very weak passwords, no encryption and does not support very large datasets (>50k patients). Please do not put patient data in the appliance without considering these contraints.

If you run into this error: "One or more of the disks used by this virtual machine was created by an unsupported version", open the Openmrs.vmdk file in a hex editor (because its very large) and replace virtualHW.version = "6" with virtualHW.version = "4". Remove the vm from the vmware inventory and reopen it.

If you have any questions, email the mailing list for assistance. If you want to help with the next version of OpenMRS appliance, see the rpath project page.

Retrieved from "http://openmrs.org/wiki/OpenMRS_Appliance"