This tutorial will introduce you to OpenMRS SDK (Server Development Kit). It assumes that you have basic understanding of OpenMRS modular architecture (you can learn about it reading Technical Overview).
...
If you want to enable remote debugging by default when running the server,
specify the port number here (e.g. 1044). Leave blank to disable debugging.
(Do not do this on a production server) (default: 'no debugging'):
Type default value '1044' and push enter. Specifying debug port is essential to setup remote debugging configuration. You will be asked what database you want to use:
...
To sum up, our openmrs-distro.properties file will look like this:
name= OWA development
version= 1.0
war.openmrs= 2.0
omod.owa=1.6.2
omod.webservices.rest=2.17-SNAPSHOT
SDK automatically assumes that modules Maven Group ID is 'org.openmrs.module', but you can declare another Group ID
...
To allow others to reproduce your server configuration, you have to create 'openmrs-distro.properties' file with modules deployed on failing server. Since SDK 3.4.x you can go to your server directory `{user directory}/openmrs/{name of server}` and copy this file to share it with others. If you are using older version of SDK or standalone OpenMRS, you need to manually create this file as described in Creating new distribution.
Creating MySQL dump file
Best way to replicate database state is to create SQL dump with mysqldump. Mysqldump will require database name, user name and password. To create dump from dockerized MySQL database, you need to use mysqldump from within the container.
We will walk through creating dump from MySQL database in SDK container.
First, ensure that SDK container "openmrs-sdk-mysql-v3-2" is started:
| Code Block |
|---|
docker start openmrs-sdk-mysql-v3-2 |
in next step, you have to enter container with command:
| Code Block |
|---|
docker exec -it openmrs-sdk-mysql-v3-2 mysqldump -u root -pAdmin123 {name of server} > dump. |
...
sql |
Username 'root' and password 'Admin123' are standard credentials for MySQL instance in container created by SDK. After command execution, you should have dump.sql file in your working directory.
Setting up server
Now, if you want to replicate environment of other developer, and you are provided openmrs-distro.properties and dump.sql, you can do that in one step:
| Code Block |
|---|
mvn openmrs-sdk:setup -DdbSql=dump.sql -Drun |
from directory where you have those 2 files. flag '-Drun' makes SDK automatically run server after successful setup. Go to http://localhost:8080/openmrs/ to complete the setup.
Related articles
...