Clear steps on how to install OpenMRS 3.0

Application Name: Openmrs Platform Version Number: 3.0

Question: Please I would like someone to guide me on how to set up Openmrs 3.0 platform and deploy our existing custom modules in the 3.0 instance. I have searched online and tried the following links OpenMRS Frontend 3.0 Documentation for Developers and O3 Implementer Documentation: Set Up, Configure & Deploy - Projects - OpenMRS Wiki. Still, there is no simple and straight instruction on how to set up the 3.0 platform or upgrade an old instance in our Health facilities to the new 3.0, all the documentations in the mentioned links are somewhat confusing and not directly speaking to very simple steps on how to do this setup. I would appreciate it if there is a video guide or simple steps. Thank you **

The short version of this is that OpenMRS 3.0 doesn’t require platform changes as long as you are running OpenMRS Platform 2.2 or higher and already have the modules noted here. O3 is primarily a new UI and that part has extensive changes, but you’re still following one of the two deployment paths laid out in the implementer tools.

If you are not yet on Platform 2.2 or higher or want to upgrade to a newer version, the process is the same as it always was. Similarly, if you have some of the modules listed, but not the latest versions, those should be upgraded in the usual way.

2 Likes

This is not clear for a new developper joining the openmrs community. Can’t we just have clear step as to how we install openmrs 2.2 or higher and how we add the new ui on top of it?

I’ve sincerly been looking for a clear way to do so for like a month now but still no clear way

@hlabs See the wiki page here: https://openmrs.atlassian.net/wiki/spaces/projects/pages/26936930/O3+Implementer+Documentation+Set+Up+Configure+Deploy

Thanks for your answer, but I’ve already tried using this link. I just got confused over time when following it. Hopefully, you will be available for a google meet call. I really need help because I am not primarily a java developer, so I really do not understand all the process.

This is my email: danielgolo82â– â– â– â– â– â– â– â– â– â– 

Best regards

I think this is still a problem. I’ve been bashing my head on this for a couple days, and also tried late last year when I had some time. Starting with the he wiki page you listed, it comes up with " Better O3 Documentation is Available - Please Note: Since this page was last created/updated, we have created a much better set of O3 Docs. Please see instead: O3 for Developers"

Those new instructions (video “Setting Up O3 with Docker”) recommend using gitpod rather than docker installed in my case via apt on ubuntu 22.04. I have gone through a couple of cycles of trying to get to the point of even getting a successful build and taking on a bug, but instead, I find the whole setup frustrating and inconsistent.

There are other sets of instructions around too. For example, https://openmrs.atlassian.net/wiki/spaces/docs/pages/25477022/Getting+Started+as+a+Developer was updated April 29 and refers to https://openmrs.atlassian.net/wiki/spaces/docs/pages/151093495/Introduction+to+O3+for+Developers which then links to pages like “Setting Up An Instance of O3”, which offers Docker and a slightly dated reference in step 2 to " O3 Distribution", uses MySQL but not PostgreSQL which is also supported, etc.

I am reluctant to bother people with problems I assume are mine, especially since I come from a significantly different background and am not that familiar with the toolset. A canonical set of instructions, well tested, repeatable, maintained, readable/not in a video would be really helpful. Take the others down.

1 Like

So there’s a lot to be said here. First, there are quite a few ways of running OpenMRS and how you should run it depends on what you’re trying to do.

If you’re just trying to help develop the O3 frontend, then no installation should be necessary. We have a hosted service that most frontend modules will default to connecting to. However, if you want to contribute to the frontend and run things locally, Docker is probably the fastest way to replicate the setup we use. GitPod isn’t an alternative to Docker, it’s an alternative to running the code / IDE on your machine, which is especially helpful as it can save on network bandwidth and the like and ensure your machine meets minimum recommendations.

If you’re looking to contribute to the backend of OpenMRS, then you’d most likely want to use the SDK, which is a Maven-based tool that aims to simplify the setup for backend developers. You can use Docker for this, but it tends to be less convenient to do so. The SDK setup can also be used to develop the O3 frontend, but since installing it requires a JDK and Maven, which are not otherwise needed for purely frontend work, we don’t necessarily recommend it.

Finally, if you’re actually trying to run OpenMRS at a facility, things are somewhat different as running the backend through the SDK is not really the right way to do things.

Unfortunately, there is no singular “canonical set of instructions” because the instructions vary with what you’re trying to do. The instructions you’ve linked to though, are all well-tested, repeatable, and maintained.

2 Likes