Note It is mandatory to shutdown your OpenLM Server, and do a full backup of the OpenLM Database before proceeding with the upgrade
Upgrading to OpenLM Version 21 or higher:
This guide will provide instructions for how to upgrade OpenLM Server Version 21 or higher and configure it with the Identity Service.
Understanding the installation process will allow you to properly set up OpenLM, configure the initial steps required to activate the Identity Server, and clarify any of the options presented by the OpenLM Server installer.
The main process would entail:
- installing a database server,
- setting up a new database for OpenLM Server and migrating old data,
- installing the OpenLM Server component,
- setting up the Identity Service database and
- installing the Identity Service component.
To upgrade to Version 21 or higher, the OpenLM server has to first be upgraded to Version 5.6. To upgrade to Version 5.6 please follow the steps explained in this video.
Before you start the upgrade (Checklist)
For a smooth upgrade to OpenLM Version 21 or higher, please go through the following checklist and make sure that
- The required ports are open
- Your Windows/Linux operating system is compatible with OpenLM v21 and higher
- The hardware meets the minimum requirements
- Powershell is compatible with OpenLM v21 and higher (Windows/Linux). For Windows users we recommend using Powershell: 5.1 or above, for Linux users Powershell 7.1.)
- You have a static MAC address – Cloud-based servers must use ENI. )If you want to find out your MAC address click here.)
- Your database management system is compatible with OpenLM v21 and higher
- Your web browser is supported and it is up-to-date. (We support Mozilla Firefox, Microsoft Edge and Google Chrome)
- additional requirements FOR LINUX USERS ONLY:
- systemctl command (systemd)
- redhat-lsb package (installed by default in Ubuntu)
If you are using an earlier version of OpenLM than 5.6 you must know that FireBird is no longer supported. OpenLM supports the following three databases:
- MS SQL Server
If this is the case, then as a first step you must migrate your OpenLM’s embedded FireBird database to any of the supported databases mentioned above. To learn more about the migration process, click here.
Now you are ready to upgrade to OpenLM V21 or higher. Follow the steps below:
Step 1. Download the latest version of OpenLM from our website. Depending on the operating system you use, select the MSI or Linux package.
OpenLM download link: Windows / Linux: tar.gz .deb .rpm
Check your license file:
Please make sure you have an OpenLM V21 or higher license file (Contact at Sa***@op****.com).
If you are going to use Identity Service in Security mode, for further user role assignment capabilities please make sure to have Roles & Permissions in OpenLM License. If you want to know details of V21 or higher Roles & Permissions, please refer to the Identity Service Manual Roles & Permissions steps.
Step 2 – OpenLM Server Database setup
The OpenLM Server component requires the use of an external database source such as MariaDB, MySQL, or Microsoft SQL Server.
See below the process of setting up a new database for OpenLM for each of the supported types.
Select the database type you have and refer to the documentation below to set up a new database for OpenLM Version 21 or higher.
Step 3 – OpenLM Server setup (Video)
The following documentation details the process for installing and setting up the OpenLM Server component to be used with the database created in previous steps.
1. Download OpenLM Server Version 21 or higher from the download page.
2. Make sure that the user who is logged in has full access permissions in the folder “C:Program FilesOpenLM” folder.
3. Place it on the correct host server and run the installer file from a user account that has administrative permissions on that particular server.
4. If you agree to the terms and want to continue with the upgrading, click the “I Agree” radio button. Clicking the radio button will enable the “Next” button. Clicking “Cancel” will exit the installer without any changes having been made.
5. Select where the OpenLM Server should be located.
The default path is “C:Program Files (x86)OpenLMOpenLM Server”, then click” Next”.
6. The OpenLM database Configuration tool will pop up and will require the OpenLM database details.
Select the correct database type and input the OpenLM database details.
7. Click the “Test connection” button and check if the connection with the database was successful.
8. If the connection is successful, click “Approve” and wait until the script creates all relevant tables, then click “Finish”.
- If you do not have any type of database instance and would like to use the embedded one, then the OpenLM Server will automatically install MariaDB on port 3307 for you.
- The installer will also automatically create a database named “MariaDB_OpenLM_Server“ with the username and password “openlm” for you to connect to, using the OpenLM Database Configuration tool shown above.
9. Once done, you will be directed to the” Finish” prompt:
10.The License Activation window will pop up on the default browser (OpenLM supports Chrome, Mozilla, and Edge)
- If you already have the OpenLM license file. then place it in the OpenLM “License” folder, which is usually located in “C:Program FilesOpenLMOpenLM Serverlicense”.
- Then go to Windows “Services”, restart the OpenLM Server service and close the “OpenLM License Activation” window.
11. If you do not have an OpenLM license file, then the installer will be able to generate one for you.
12. Fill in all the required information about the organization and click “Next”.
13. You will receive an activation email, so simply check your inbox and paste the Activation code.
14. Download the created license file and implement it as such:
- Now that you have the OpenLM license file, simply place it in the OpenLM “License” folder, usually located in “C:Program FilesOpenLMOpenLM Serverlicense”.
- Then go to Windows “Services”, restart the OpenLM Server service, and close the “OpenLM License Activation” window.
15. Open up your browser (Chrome, Mozilla, Edge) and navigate to the EasyAdmin interface by clicking on its shortcut.
You can also navigate to “http://server_name_here:5015” in order to open up the OpenLM User Interface (EasyAdmin)
Step 4 – Identity Service Database setup
The OpenLM Identity Service component requires the use of an external database source such as MariaDB, MySQL or Microsoft SQL Server.
Click on the database type you have and follow the steps described in the tutorial to set up a new database for the Identity Service.
Step 5 – Identity Service setup (Video)
The Identity Service is a secured solution that manages authentication for all OpenLM products. It uses the industry-standard OAuth 2.0 and serves to immediately log a user.
Below is a short guide on how to install and configure the Identity Service:
- On the OpenLM website, obtain the OpenLM Identity Service. Double-click on it to trigger the installation process:
2. Carefully read the terms and conditions. If you agree, tick the box to accept, then click “Next”.
3. The Identity Service requires an empty database. Make sure you have one before continuing with the installation:
4. The “Next” prompt will reveal the temporary username and password. We strongly recommend changing them immediately:
5.Immediately after that, you will be directed to the database configuration tool prompt. Type in all the required details. Test the connection. If successful, click “Approve”.
- If you are installing from scratch, you need to create an empty database dedicated to Identity Service.
- Please create an empty database according to system requirements (the same as V21 or higher OpenLM Server Database).
- Please do not type OpenLM Server database but the empty Identity Service database in the DB configuration window below. If you are using an existing database from a previous version, please just type the connection info.
6. Enter the port number, then click “Enter”. The default port is 5000:
NOTE: Please do not use a port number that is occupied by another application.
If you are not sure, please use the default 5000.
CMD Command to check if a port is free: netstat -a -n -o | find “5000”
7. In the following steps, the database will be created and the Identity Service configured:
8. When the configuration is completed, press “Enter”.
9. Hit the “Finish” button. You will be redirected automatically to the OpenLM Identity Service UI. Sign in using the provided default credentials:
Default credentials are:
10.You will then be asked to change the temporary password. Type in a new, reliable password, confirm it, then hit the “Change” button:
11. Once the password has been changed, you will be redirected to the login page. Use your new credentials to access the Identity Service account.
Congratulations! You have successfully set up Identity Service.
If you experienced issues during the setup process please watch this troubleshooting video: (Troubleshooting Video)
Now you are ready to configure the Identity Service to secure the OpenLM components. Click here to learn how to configure OpenLM’s Identity Service.