Have you implemented OpenMRS? Please participate in the Implementation Site Survey. If you already have, thank you!
Child pages
  • Setting Up a Development Environment for OpenMRS 2.x

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


In eclipse you can set this up as a Run Configuration like:

  • Base directory:

    Code Block
  • Goals: jetty:run

Set the following VM options to use our preferred webapp name, give OpenMRS sufficient memory, and enable rapid UI development (replacing with correct pointers to the source code you have checked out):

Code Block

-Xms512m -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=512m

Running the Reference Application in a production-like environment.

The target environment for CI, and other servers is Tomcat7 running on Ubuntu 12.04.  If you'd like create a virtual machine in your environment for testing, see the wiki page: Developer How-To Launch a local instance of the Reference Application.


In order to get omods of all modules which are part of the Reference Application distribution you need to clone https://github.com/openmrs/openmrs-distro-referenceapplication and run mvn clean package. This command will produce a zip file with omods in the target directory which you can unzip into the module directory in your Application Data directory (skip the war file). You need to restart OpenMRS to have all the modules installed and started.


All modules can be built by running mvn clean install. If some module is not building for you, please check its status in our CI. If it is green, then it means that it is only your local problem and you need to resolve it yourself. If you need assistance, please contact us.

Maven versions plugin

Use the following command to update the pom.xml for the openmrs-distro-referenceapplication repository if you need to have the latest versions of all the modules included in the Reference Application.

Code Block
mvn versions:update-properties -DallowSnapshots=true -DexcludeProperties=uiframeworkModuleVersion,openMRSVersion

If you'd like to push this change to the master branch in GitHub, please discuss the changes on the dev-refapp@openmrs.org mailing list before pushing.

Handful commands:

Code Block
git clone https://github.com/YOUR_ACCOUNT/openmrs-module-appframework

git remote add upstream https://github.com/openmrs/openmrs-module-appframework

mvn clean install