Deploying Hyperon

Migrate Hyperon applications from 1.X.X to 2.X.X guide

This is wise to upgrade Hyperon (the Studio and Runtime) for a newer version as we are repairing bugs and adding new features, so let's check how to do it in a few short steps.


  • As far hyperon-studio and hyperon-runtime are separate applications we truly recommend running them the same version.
  • Hyperon Studio MUST BE STARTED FIRST! Why? Hyperon Studio is managing the Database Schema! And there is A MUST, to run a Hyperon Studio before Hyperon Runtime
  • If you are lower than 1.20.x version we recomend to upgrade to the latest version in 1.x line (for instance: 1.21.8) firstly. You can do this following this instructions.


  • use java 11 as the minimal runtime environment
  • change properties names so please check your property source if it needs a change    

1. Bump the hyperon-studio application

1.1 Download new Studio

The first step you should do is to head for new applications here. After filling the form, you will get mail with a link to your download page. Search for version 2.x.x.

Depending on your needs, download the file/files (probably you use a war file with your tomcat)

1.2 Shut down a Hyperon Studio

Turn off Hyperon Studio. You probably want to stop all running applications which are using hyperon-runtime, because we need to modify its database schema.

1.3 Remember to create a database backup!

Due to the fact, there might occur database updates, it would be very helpful if you prepare a hyperon's database backup.

1.4 Upgrade java to 11 version

Hyperon Studio 2.x.x is using Java 11 to run (the minimal version).
You should upgrade the java version in your application container

1.5 Check out new properties

In a Hyperon Studio 2.x.x there were a lot of changes with properties.

Take a look at your property source (by default: {your_tomcat_dir}/conf/ and change them according to the this table.

1.6 Switch war files at your tomcat webapps directory

1.7 Start the hyperon-studio

If everything went well (and it should!) it's time to start the Hyperon Studio!
After starting you should be able to see a standard Hyperon Studio login page (by default: https://{serverUrl}/hyperon/app).

2. Bump the hyperon-runtime in your applications

To do that you should perform only two steps:

  • Hyperon-Runtime is available at Maven Central repositories, so the easiest way to bump its version is to change a version number at your building script (pom.xml, build.gralde, etc). Here is a place where you can find our artifacts.
  • Check out the new properties. In a Hyperon Runtime 2.x.x there were a lot of changes with properties. Take a look at the property source of your application (where you defined hyperon database connection) and change them according to the table

That's all! Now you can run your application with a brand new hyperon-runtime version.

Remember, You must bump hyperon-studio firstly.